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

Подробное описание

Класс отвечает за список свойств Orm объекта. Позволяет выполнять массовые операции со всеми свойствами. Помещать свойства в группы, которые в дальнейшем будут представлены как закладки в форме

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

	append (array $properties)

	group ($name)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	move ($key, $to_key, $after=true)

	offsetUnset ($offset)

	current ()

	key ()

	next ()

	rewind ()

	valid ()

	beforeSave ()

	getGroups ($hide_empty_multiedit=null, $switch=null, $use_default_visible=true)

	getGroupList ($hide_empty_multiedit=null)

	getGroupName ($n)

	getValues ()

	setValues (array $values)

	getKeys ()

	getVisibleKeys ()

	getMultieditKeys ()

	addMultieditKey ($key)

	groupSet ($property, $value)

	cancelGroupSet ()

	arrayWrap ($array_wrap_name)

	export ()

	exportGroups ()

	appendPropertyIterator (PropertyIterator $property_iterator, $overwrite=false)

	setPropertyOptions ($options)

Поля данных
	$data = []

	$group_set

	$groups = []

	$currentgroup

	$cache_groups = []

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

__construct ( array $properties = null )

Конструктор

Аргументы

array $properties - массив элементов | string со свойствами или именем группы

Методы

addMultieditKey ( $key )

Добавляет в список ключи свойств, которые должны быть видимы при мультиредактировании

Аргументы

$key

Возвращает: $this

append ( array $properties )

Дополняет список свойств

Аргументы

mixed $properties

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

appendPropertyIterator	(	PropertyIterator	$property_iterator,
			$overwrite = `false`
	)

Дополняет свойства новыми полями из $property_iterator

Аргументы

PropertyIterator	$property_iterator
bool	$overwrite	- Если true, то добавляемые свойства будут заменять имеющиеся

Возвращает: $this

arrayWrap ( $array_wrap_name )

Оборачивает имена форм всех свойств в массив

Аргументы

string $array_wrap_name

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

beforeSave ( )

Вызывается перед сохранением ORM объекта, через метод $orm->save()

cancelGroupSet ( )

Отменяет установку свойств

current ( )

Возвращает значение по текущему указателю. Iterator

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

export ( )

Возвращает массив с объектами свойств

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

exportGroups ( )

Возвращает список всех групп

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

getGroupList ( $hide_empty_multiedit = null )

Возвращает список групп

Аргументы

bool | null $hide_empty_multiedit - Если задано true, то скрывать пустые закладки для режима мультиредактирования, false - скрывать для режима обычнго редктирования, null - возвращать все.

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

getGroupName ( $n )

Возвращает имя группы

Аргументы

integer $n Порядковый номер группы

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

getGroups	(	$hide_empty_multiedit = `null`,
		$switch = `null`,
		$use_default_visible = `true`
	)

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

Аргументы

bool \| null	$hide_empty_multiedit	- Если задано true, то скрывать пустые закладки для режима мультиредактирования, false - скрывать для режима обычнго редктирования, null - возвращать все.
string \| null	$switch	- Контекст отображения
bool	$use_default_visible	- Использовать свойство Visible, если не задан отдельный <switch>Visible для контекста switch

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

getKeys ( )

Возвращает ключи свойств

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

getMultieditKeys ( )

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

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

getValues ( )

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

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

getVisibleKeys ( )

Возвращает ключи видимых свойств

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

group ( $name )

Устанавливает текущую группу, для отображения

Аргументы

string $name - Название группы

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

groupSet	(	$property,
		$value
	)

Установит свойству $property значение $value при вызове offsetSet

Аргументы

string	$property
mixed	$value

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

key ( )

Возвращает ключ текущего элемента. Iterator

Возвращает: int|mixed|string|null

move	(	$key,
		$to_key,
		$after = `true`
	)

Перемещает пару ключ-значение в списке

Аргументы

string	$key	Ключ, который следует перенести
string	$to_key	Ключ, куда следует перенести поле $key
bool	$after	$after - Если true, то вставка будет после $to_key, если false, то перед ним

next ( )

Переводит на следующий элемент. Iterator

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

offsetExists ( $offset )

Возвращает true, если поле с ключем $offset присутствует. ArrayAccess

Аргументы

mixed $offset

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

offsetGet ( $offset )

Возвращает значение по ключу $offset. ArrayAccess

Аргументы

mixed $offset

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

offsetSet	(	$offset,
		$value
	)

Устанавливает значение ключу $offset. ArrayAccess

Аргументы

mixed	$offset
mixed	$value

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

Исключения

Exception

offsetUnset ( $offset )

Удаляет значение для ключа $offset. ArrayAccess

Аргументы

mixed $offset

rewind ( )

Переводит итератор на первый элемент. Iterator

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

setPropertyOptions ( $options )

Устанавливает параметры для всего набора свойств

Аргументы

$options

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

setValues ( array $values )

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

Аргументы

array $values

Возвращает: $this

valid ( )

Проверяет корректность текущей позиции. Iterator

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

Поля

$cache_groups = []

$currentgroup

$data = []

$group_set

$groups = []

Подробное описание

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

Поля данных

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

Методы

Поля