Граф наследования:AbstractType:

Открытые члены
	__construct (array $options=null)

	processOptions ($options)

	beforesave ()

	getCheckboxParam ($key=null)

	set ($value)

	setListenPost ($boolean)

	isListenPost ()

	get ()

	getHint ()

	setHint ($text)

	setEscapeType ($escape_type)

	getEscapeType ()

	unsetvalue ()

	validate ($value)

	setChecker ($callmethod, $errortxt= '')

	removeAllCheckers ()

	getCheckers ()

	setVisible ($bool, $switch=null)

	isVisible ($switch=null, $use_default_visible=true)

	isMeVisible ($switch=null, $use_default_visible=true)

	setMeVisible ($bool)

	getTreeList ()

	setTree ($tree_function,...$params)

	getListFunc ()

	setList ($listfunc,...$params)

	setListFromArray (array $list)

	setChangeSizeForList ($bool)

	getList ()

	setCheckboxView ($onValue, $offValue)

	setCheckboxListView ($bool)

	setRadioListView ($bool, $inline=false)

	isRadioListInline ()

	selfSave ()

	normalizePost ()

	addClass (string $class)

	setAttr (array $view_attr)

	getAttr ()

	getAttrArray ()

	getAttrByKey ($key)

	isHaveAttrKey ($key)

	textView ()

	formView ($view_options=null, $orm_object=null)

	setName ($name)

	getName ()

	setArrayWrap ($array_wrap_name)

	setFormName ($form_name)

	getFormName ()

	setMaxLength ($length)

	getMaxLength ()

	isAlwaysModify ()

	setAlwaysModify ($bool)

	setReadOnly ($readonly=true)

	setErrors (array $errors)

	getErrors ()

	hasErrors ()

	getDescription ()

	setDescription ($description)

	setUseToSave ($bool)

	isUseToSave ()

	isRuntime ()

	setRuntime ($bool)

	isAutoincrement ()

	setAutoincrement ($bool)

	hasLength ()

	setAllowEmpty ($bool)

	isAllowEmpty ()

	getSQLNotation ()

	getSQLTypeParameter ()

	setDecimal ($decimal)

	getDecimal ()

	setPrimaryKey ($bool)

	isPrimaryKey ()

	setUnique ($bool)

	isUnique ()

	setIndex ($bool)

	isIndex ()

	setDefault ($default, $is_func=false)

	getDefault ($db_format=false)

	isDefaultFunc ()

	getPhpType ()

	setPhpType ($type)

	setTemplate ($template)

	setMeTemplate ($template)

	getOriginalTemplate ()

	getRenderTemplate ($multiedit=false)

	getTitle ()

	setHidden ($bool)

	isHidden ()

	escape ($value)

	checkDefaultRequestValue ($value)

	setRequestType ($var_type)

	getFromRequest (array $src)

	callPropertyFunction ($property_name,...$params)

	setTrimString ($bool)

	getTrimString ()

	isHtmlEncodedField ()

	__set ($name, $value)

	__get ($name)

	__isset ($name)

	__unset ($name)

Поля данных
const	ESCAPE_TYPE_NONE = false

const	ESCAPE_TYPE_ENTITY = 'entity'

const	ESCAPE_TYPE_HTML = 'html'

	$name

	$description

	$formtype = "input"

Защищенные данные
	$listfunc

	$listfunc_param = []

	$tree_function

	$tree_function_params = []

	$list

	$parent_object

	$value

	$hidden = false

	$requesttype

	$checkers = []

	$use_to_save = true

	$read_only = false

	$array_wrap_name = false

	$form_template = '%system%/coreobject/type/form/string.tpl'

	$template

	$me_template

	$change_size_for_list = true

	$always_modify = false

	$errors = []

	$listen_post = true

	$hint = ''

	$checkbox_param = []

	$checkbox_list = false

	$radio_list = false

	$radio_list_inline = false

	$vis_form = true

	$me_visible

	$view_attr = []

	$php_type = ''

	$escape_type = self::ESCAPE_TYPE_ENTITY

	$runtime = false

	$sql_notation = ''

	$autoincrement = false

	$allowempty = true

	$primary_key = false

	$default = null

	$is_default_func

	$unique = false

	$index = false

	$has_len = true

	$max_len

	$decimal

	$form_name

	$trim_string = false

	$options = []

Конструктор(ы)

__construct ( array $options = null )

Конструктор свойства

Аргументы

array $options - массив для быстрой установки параметров

Методы

__get ( $name )

Возвращает значение произвольного свойства

Аргументы

string $name Идентификатор свойства

Возвращает: mixed

__isset ( $name )

Возвращает true, если произвольное свойство существует (было задано)

Аргументы

string $name Идентификатор свойства

Возвращает: bool

__set	(	$name,
		$value
	)

Обрабатывает установку произвольных свойств

Аргументы

string	$name	Идентификатор свойства
mixed	$value

__unset ( $name )

Удаляет произвольное свойство

Аргументы

string $name Идентификатор свойства

Возвращает: void

addClass ( string $class )

Дополняет список классов элемента формы

Аргументы

string $class - класс

Возвращает: static

beforesave ( )

Вызывается для каждого свойства перед сохранением

Возвращает: void

callPropertyFunction	(	$property_name,
		$params
	)

Выполняет анонимную функцию, назначенную свойству текущего объекта. Метод необходим для реализации выполнения анонимных функций в шаблонах Smarty.

Аргументы

string	$property_name	- назнание свойства
array	$params	- параметры, которые будут переданы в анонимную функцию

Возвращает: mixed

checkDefaultRequestValue ( $value )

Проверяет значение $value и подставляет значение по-умолчанию, если таковое действие требуется

Аргументы

mixed $value

Возвращает: mixed $value

escape ( $value )

Возвращает экранированное значение value согласно типу экранирования данного класса

Аргументы

mixed $value

Возвращает: mixed

formView	(	$view_options = `null`,
		$orm_object = `null`
	)

Возвращает HTML код формы свойства

Аргументы

array \| null	$view_options	- параметры отображения формы. если null, то отображать все Возможные элементы массива: 'form' - отображать форму, 'error' - отображать блок с ошибками, 'hint' - оторажать ярлык с подсказкой,
object \| null	$orm_object	- orm объект, которому принадлежит поле

Возвращает: string

Исключения

\SmartyException

get ( )

Возвращает значение свойства или значение по-умолчанию

Возвращает: mixed

getAttr ( )

Возвращает атрибуты для элемента формы

Возвращает: string

getAttrArray ( )

Возвращает аттрибуты в виде массива

Возвращает: array

getAttrByKey ( $key )

Возвращает значение назначеного аттрибута по ключу или false

Аргументы

string $key - ключ массива с аттрибутами

Возвращает: mixed|false

getCheckboxParam ( $key = null )

Возвращает параметры для checkbox'а

Аргументы

string $key

Возвращает: mixed

getCheckers ( )

Возвращает массив с checker'ами

Возвращает: array

getDecimal ( )

Возвращает количество знаков дробной части

Возвращает: integer | null

getDefault ( $db_format = false )

Возвращает значение поля в базе по-умолчанию

Аргументы

bool $db_format - привести результат к хранимому в БД виду

Возвращает: mixed

getDescription ( )

Возвращает описание данного свйства

Возвращает: string

getErrors ( )

Возвращает массив с ошибками данного свойства

Возвращает: array

getEscapeType ( )

Возвращает тип экранирования значения, получаемого из GET, POST, REQUEST

Возвращает: mixed

getFormName ( )

Возвращает имя формы свойства

Возвращает: string

getFromRequest ( array $src )

Заполняет, экранирует и возвращает значение поля из сведений переданных браузером

Аргументы

array $src - массив исходных данных (обычно это _POST + _FILES)

Возвращает: mixed

getHint ( )

Возвращает краткую подсказку для формы свойства

Возвращает: string

getList ( )

Возвращает список возможных значений, установленных фцнкуиями: setList или setListFromArray

Возвращает: array | null

getListFunc ( )

Возвращает функцию назначенную у ORM объекта

Возвращает: mixed

getMaxLength ( )

Возвращает максимальную длину значения свойства

Возвращает: integer

getName ( )

Возвращает имя свойства

Возвращает: string

getOriginalTemplate ( )

Возвращает шаблон по-умолчанию для данного поля

Возвращает: string

getPhpType ( )

Возвращает тип данного свойства в PHP, основываясь на gettype()

Возвращает: string

getRenderTemplate ( $multiedit = false )

Возвращает шаблон, который будет использован для отображения свойства

Аргументы

bool $multiedit - вернуть шаблон для мультиредактирования

Возвращает: string

getSQLNotation ( )

Возвращает обозначение данного типа в SQL

Возвращает: string

getSQLTypeParameter ( )

Возвращает строковое значение параметра, которое подставляется после SQL - типа Для большинства типов это его длина, например INT(11), VARCHAR(255), но для некоторых типов это могут быть другие значения, например: ENUM('Y', 'N') или DECIMAL(10,2)

Возвращает: string

getTitle ( )

Возвращает название свойства для отображения пользователям

Возвращает: string

getTreeList ( )

Возвращает итератор для отображения формы в виде элемента SELECT

Возвращает: AbstractTreeListIterator

getTrimString ( )

Возвращает свойство TrimString

Возвращает: bool

hasErrors ( )

Возвращает true, если есть ошибки у данного свойства

Возвращает: bool

hasLength ( )

Возвращает true, если поле имеет длину в SQL обозначении

Возвращает: bool

isAllowEmpty ( )

Возвращает true, если поле позволяет иметь значение NULL

Возвращает: bool

isAlwaysModify ( )

Возвращает true, если это свойство нужно читать всегда модифицированным

Возвращает: bool

isAutoincrement ( )

Возвращает true, если поле является автоинкрементным

Возвращает: bool

isDefaultFunc ( )

Взвращает true, если значением поля по-умолчанию является функция

Возвращает: bool

isHaveAttrKey ( $key )

Возвращает true если существует ключ аттрибута

Аргументы

string $key - ключ массива с аттрибутами

Возвращает: boolean

isHidden ( )

Возвращает true, если поле необходимо отображать в виде input[type="hidden"]

Возвращает: bool

isHtmlEncodedField ( )

Возвращает false, если данное поле не кодируется в базе данных

Возвращает: bool

isIndex ( )

Возвращает true, если данное поле содержит индекс

Возвращает: bool

isListenPost ( )

Возвращает true, если данное свойство можно заполнять из POST

Возвращает: bool

isMeVisible	(	$switch = `null`,
		$use_default_visible = `true`
	)

Возвращает true, если поле видимо в форме мультиредактирования

Аргументы

string	$switch	- префикс свойства видимости, которое отвечает за отображение свойства в контексте
boolean	$use_default_visible	- Если true, то по умолчанию возвращается значение общей видимости (Visible)

Возвращает: bool

isPrimaryKey ( )

Возвращает, является ли данное поле первичным ключем

Возвращает: bool

isRadioListInline ( )

isRuntime ( )

Возвращает true, если данное поле не связано с хранилищем

Возвращает: bool

isUnique ( )

Возвращает true, если данное поле содержит уникальный индекс

Возвращает: bool

isUseToSave ( )

Возвращает true, если свойство можно сохранять, иначе - false

Возвращает: bool

isVisible	(	$switch = `null`,
		$use_default_visible = `true`
	)

Возвращает true, если свойство должно быть видимым в форме

Аргументы

string	$switch	- префикс свойства видимости, которое отвечает за отображение свойства в контексте
boolean	$use_default_visible	- Если true, то по умолчанию возвращается значение общей видимости (Visible)

Возвращает: bool

normalizePost ( )

Если у вас есть разница между видом данных загруженных во время загрузки объекта и видом данных полученных с POST'a, то в этой функции нужно приводить данные, полученные с поста к виду данных загружаемых из БД.

Возвращает: void

processOptions ( $options )

Вызывает методы set.... или add... для ключей массива options

Аргументы

array $options

Возвращает: static

removeAllCheckers ( )

Удаляет все checker'ы

Возвращает: void

selfSave ( )

Вызывается у каждого свойства перед сохранением ORM объекта.

Возвращает: void

set ( $value )

Устанавливает значение свойству

Аргументы

mixed $value

Возвращает: static

setAllowEmpty ( $bool )

Устанавливает, может ли данное поле принимать значение null

Аргументы

bool $bool

Возвращает: static

setAlwaysModify ( $bool )

Устанавливает, считать ли данное свойство всегда модифицированным

Аргументы

mixed $bool

Возвращает: static

setArrayWrap ( $array_wrap_name )

Оборачивает имя формы в массив с заданным именем

Аргументы

string $array_wrap_name имя массива-обертки

Возвращает: static

setAttr ( array $view_attr )

Устанавливает атрибуты для формы, которые нужно вставить в html в виде строки

Аргументы

array $view_attr - ассоциативный массив АТРИБУТ=>ЗНАЧНИЕ

Возвращает: static

setAutoincrement ( $bool )

Устанавливает, является ли поле автоинкрементным

Аргументы

bool $bool

Возвращает: static

setChangeSizeForList ( $bool )

Устанавливает, изменять ли атрибут size=1 для списков

Аргументы

mixed $bool - Если true - то size будет устанавливаться в 1

Возвращает: static

setCheckboxListView ( $bool )

setCheckboxView	(	$onValue,
		$offValue
	)

Отображать свойство в форме в виде checkbox

Аргументы

mixed	$onValue	- значение для включенного checkbox
mixed	$offValue	- значение для ВЫключеннго checkbox

Возвращает: static

setChecker	(	$callmethod,
		$errortxt = `''`
	)

Устанавливает обработчик входящих данных Можно установить несколько обработчиков

Аргументы

callback	$callmethod	- функция провери значения данного свойства
string	$errortxt	- текст ошибки
mixed	$callback_param	- дополнительный параметр для callback .....

Возвращает: static

setDecimal ( $decimal )

Устанавливает количество знаков дробной части

Аргументы

integer $decimal

Возвращает: static

setDefault	(	$default,
		$is_func = `false`
	)

Устанавливает значение по-умолчанию в поле базы данных

Аргументы

mixed	$default	- false означает, что значение по-умолчанию не задано
	$is_func	- если true, значит $default содержит функцию, иначе $default - это значение (влияет на обрамление ковычками во время синхронизации)

Возвращает: static

setDescription ( $description )

Устанавливает описание для свойства

Аргументы

string $description

Возвращает: static

setErrors ( array $errors )

Устанавливает список ошибок для данного свойства

Аргументы

array $errors

Возвращает: static

setEscapeType ( $escape_type )

Устанавливает тип экранирования значения, получаемого из GET, POST, REQUEST

Аргументы

mixed $escape_type - может принимать значение - false, 'entity', 'html'. См константы AbstractType::ESCAPE_TYPE_...

Возвращает: static

setFormName ( $form_name )

Устанавливает имя формы свойства

Аргументы

string $form_name - имя для формы

Возвращает: static

setHidden ( $bool )

Отображать даное свойство в виде input[type=hidden]

Аргументы

bool $bool - Если true, то поле будет скрытым, иначе видимым.

Возвращает: static

setHint ( $text )

Устанавливат краткую подсказку для свойства

Аргументы

string $text

Возвращает: static

setIndex ( $bool )

Устанавливает, содержит ли данное поле индекс

Аргументы

bool $bool

Возвращает: static

setList	(	$listfunc,
		$params
	)

Устанавливает callback, который должен вернуть ассоциативный массив для отображения формы в виде элемента SELECT

Аргументы

callback	$listfunc	- устанавливаемый callback
array	$params	- аргументы callback-функции

Возвращает: static

setListenPost ( $boolean )

Устанавливает, принимать ли данную переменную из POST во время вызова метода Save у ORM-объекта

Аргументы

mixed $boolean

Возвращает: static

setListFromArray ( array $list )

Устанавливает ассоциативный массив, элементы которого должны использоваться для отображения формы в виде элемента SELECT

Аргументы

array $list

Возвращает: static

setMaxLength ( $length )

Устанавливает максимальную длину значения свойства

Аргументы

integer $length

Возвращает: static

setMeTemplate ( $template )

Устанавливает шаблон, кторый будет использован для отображения свойства в режиме мультиредактирования

Аргументы

string $template

Возвращает: static

setMeVisible ( $bool )

Устанавливает, видимо ли поле в форме мультиредактирования

Аргументы

mixed $bool

Возвращает: static

setName ( $name )

Устанавливает имя свойства

Аргументы

string $name

Возвращает: static

setPhpType ( $type )

Устанавливает тип значения в PHP. См. идентификаторы скалярных типов в PHP

Аргументы

$type

Возвращает: static

setPrimaryKey ( $bool )

Устанавливает, что данное поле является первичным ключем

Аргументы

bool $bool

Возвращает: static

setRadioListView	(	$bool,
		$inline = `false`
	)

setReadOnly ( $readonly = true )

Устанавливает, считать ли данное свойство доступным только для чтения

Аргументы

bool $readonly

Возвращает: static

setRequestType ( $var_type )

Устанавливает тип, к которому должна приводиться переменная при получении её через POST

Аргументы

string $var_type - Тип переменной string, float, integer, array, boolean, пустая строка означает - MIXED

Возвращает: static

setRuntime ( $bool )

Устанавливает связано ли данное поле с базой данных

Аргументы

bool $bool - если true, то не связано(записи БД не будет)

Возвращает: static

setTemplate ( $template )

Устанавливает шаблон, который будет использован для отображения свойства

Аргументы

string $template

Возвращает: static

setTree	(	$tree_function,
		$params
	)

Устанавливает callback, который должен вернуть итератор для отображения формы в виде элемента SELECT

Аргументы

callback	$tree_function	- устанавливаемый callback
array	$params	- аргументы callback-функции

Возвращает: static

setTrimString ( $bool )

Устанавливает свойство TrimString

Аргументы

$bool

Возвращает: static

setUnique ( $bool )

Устанавливает, содержит ли данное поле уникальный индекс

Аргументы

bool $bool

Возвращает: static

setUseToSave ( $bool )

Устанавливает, сохранять ли данное свойство. Если нет, то будет всегда испоьзоваться значение по-умолчанию

Аргументы

bool $bool

Возвращает: static

setVisible	(	$bool,
		$switch = `null`
	)

Устанавливает, отображать ли данное свойство в форме

Аргументы

	boolean	Отображение в форме
string	$switch

Возвращает: static

textView ( )

Возвращает значение свойства в текстовом виде

Возвращает: string

unsetvalue ( )

Устанавливет знаение в null

Возвращает: void

validate ( $value )

Проверяет, соответствует ли $value заявленному типу

Аргументы

mixed $value

Возвращает: bool

Поля

$allowempty = true

protected

$always_modify = false

protected

$array_wrap_name = false

protected

$autoincrement = false

protected

$change_size_for_list = true

protected

$checkbox_list = false

protected

$checkbox_param = []

protected

$checkers = []

protected

$decimal

protected

$default = null

protected

$description

$errors = []

protected

$escape_type = self::ESCAPE_TYPE_ENTITY

protected

$form_name

protected

$form_template = '%system%/coreobject/type/form/string.tpl'

protected

$formtype = "input"

$has_len = true

protected

$hidden = false

protected

$hint = ''

protected

$index = false

protected

$is_default_func

protected

$list

protected

$listen_post = true

protected

$listfunc

protected

$listfunc_param = []

protected

$max_len

protected

$me_template

protected

$me_visible

protected

$name

$options = []

protected

$parent_object

protected

$php_type = ''

protected

$primary_key = false

protected

$radio_list = false

protected

$radio_list_inline = false

protected

$read_only = false

protected

$requesttype

protected

$runtime = false

protected

$sql_notation = ''

protected

$template

protected

$tree_function

protected

$tree_function_params = []

protected

$trim_string = false

protected

$unique = false

protected

$use_to_save = true

protected

$value

protected

$view_attr = []

protected

$vis_form = true

protected

const ESCAPE_TYPE_ENTITY = 'entity'

const ESCAPE_TYPE_HTML = 'html'

const ESCAPE_TYPE_NONE = false

Открытые члены

Поля данных

Защищенные данные

Конструктор(ы)

Методы

Поля