The AMI_ModSpecblock_ArrayIteratorItem class

AMI_ArrayIteratorItem
   |
   --AMI_ModSpecblock_ArrayIteratorItem

• Introduction

Specblock array iterator item model.

• Class synopsis

AMI_ModSpecblock_ArrayIteratorItem extends AMI_ArrayIteratorItem {

/* Inherited Properties */

// Item search conditions

protected AMI_ArrayIteratorItem::$aCondition = array();

// Element data

protected AMI_ArrayIteratorItem::$aData = array();

// Field callbacks

protected AMI_ArrayIteratorItem::$aFieldCallbacks = array();

// Fields to load

protected AMI_ArrayIteratorItem::$aFields = array();

// Iterator pointer

protected AMI_ArrayIteratorItem::$dataIndex = -1;

// Element id value

protected AMI_ArrayIteratorItem::$id;

// Iterator model

protected AMI_ArrayIteratorItem::$oIterator;

// Primary key field name

protected AMI_ArrayIteratorItem::$primaryKeyField = 'id';

/* Methods */

// Returns module Id.

public getModId ( ) returns string;

/* Inherited Methods */

// Initializing array item data.

public AMI_ArrayIteratorItem::__construct ( AMI_ArrayIterator $oIterator, [ $aData = array() ], [ $aFields = array() ] ) returns AMI_ArrayIteratorItem;

// Adds item search condition.

public AMI_ArrayIteratorItem::addSearchCondition ( $aCondition ) returns AMI_ArrayIteratorItem;

// Returns the current element.

public AMI_ArrayIteratorItem::current ( ) returns mixed;

// Returns data array.

public AMI_ArrayIteratorItem::getData ( ) returns array;

// Returns current item primary key value.

public AMI_ArrayIteratorItem::getId ( ) returns mixed;

// Returns module id.

public AMI_ArrayIteratorItem::getModId ( ) returns string;

// Returns primary key field name.

public AMI_ArrayIteratorItem::getPrimaryKeyField ( ) returns string;

// Returns raw data array.

public AMI_ArrayIteratorItem::getRawData ( ) returns array;

// Returns validator exception object validator after save or null.

public AMI_ArrayIteratorItem::getValidatorException ( ) returns AMI_ModTableItemException|null;

// Returns validators.

public AMI_ArrayIteratorItem::getValidators ( ) returns array;

// Returns field value from data array.

public AMI_ArrayIteratorItem::getValue ( string $name ) returns mixed;

// Checks if the field has a specified callback.

public AMI_ArrayIteratorItem::hasFieldCallback ( string $field, callback $callback ) returns bool;

// Returns the key of the current element.

public AMI_ArrayIteratorItem::key ( ) returns mixed;

// Loads data.

public AMI_ArrayIteratorItem::load ( ) returns AMI_ArrayIteratorItem;

// Move forward to next element.

public AMI_ArrayIteratorItem::next ( ) returns void;

// Rewinds the Iterator to the first element.

public AMI_ArrayIteratorItem::rewind ( ) returns void;

// Sets field callback on AMI_ArrayIteratorItem::__get() and AMI_ArrayIteratorItem::__set().

public AMI_ArrayIteratorItem::setFieldCallback ( string $field, callback $callback ) returns AMI_ArrayIteratorItem;

// Set module id.

public AMI_ArrayIteratorItem::setModId ( mixed $id ) returns void;

// Sets field value in data array.

public AMI_ArrayIteratorItem::setValue ( string $name, mixed $value ) returns AMI_ArrayIteratorItem;

// Sets model values from array.

public AMI_ArrayIteratorItem::setValues ( $aData ) returns AMI_ArrayIteratorItem;

// Checks if current position is valid.

public AMI_ArrayIteratorItem::valid ( ) returns bool;

// Property access getter.

public AMI_ArrayIteratorItem::__get ( string $name ) returns mixed;

// Property access getter.

public AMI_ArrayIteratorItem::__isset ( string $name ) returns bool;

// Property access setter.

public AMI_ArrayIteratorItem::__set ( string $name, string $value ) returns void;

// Property access setter.

public AMI_ArrayIteratorItem::__unset ( string $name ) returns void;

// Calls field callbacks.

protected AMI_ArrayIteratorItem::_useFieldCallback ( string $action, string $name, mixed &$value ) returns bool;

}

Tags:

since	5.14.8
resource	specblock_array_iterator/table/model/item AMI::getResourceModel('specblock_array_iterator/table', array($IteratorTable))->getItem()

• Class Methods

// Returns module Id.

public getModId ( ) returns string;

Overrides: AMI_ArrayIteratorItem::getModId().