Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_ModSpecblock_ArrayIteratorList class

AMI_ArrayIteratorList
   |
   --AMI_ModSpecblock_ArrayIteratorList

• Introduction

Specblock array iterator list model.

• Class synopsis

AMI_ModSpecblock_ArrayIteratorList extends AMI_ArrayIteratorList {
/* Inherited Properties */
// Recordset columns
protected AMI_ArrayIteratorList::$aColumns = array();
// Search condition
// Processed data array
protected AMI_ArrayIteratorList::$aData = array();
// Primary keys array
protected AMI_ArrayIteratorList::$aKeys = array();
// Raw data array
protected AMI_ArrayIteratorList::$aRaw = array();
// Current iterator element index
// Limit read
// Default list mask
protected AMI_ArrayIteratorList::$mask = '*';
// AMI_ArrayIterator object
// Search position
// Sort direction (PHP constant)
// Field to sort by
// Start read position
// Number of found rows
/* Methods */
// Returns the active page number.
public getActivePage ( [ int $pageSize = 10 ], [ int $position = 0 ] ) returns int;
// Returns module Id.
public getModId ( ) returns string;
// Returns the pages number.
public getPagesCount ( [ int $pageSize = 10 ] ) returns int;
/* Inherited Methods */
// Initializing array data.
public AMI_ArrayIteratorList::__construct ( AMI_ArrayIterator $oIterator, [ string $mask = null ] ) returns AMI_ArrayIteratorList;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::addCalcFoundRows ( [ bool $bState = null ] ) returns AMI_ArrayIteratorList;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::addColumns ( $aColumns, [ string $model = null ] ) returns AMI_ArrayIteratorList;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::addExpressionColumn ( string $name, string $expression, [ string $model = '' ] ) returns AMI_ArrayIteratorList;
// Necessary for AMI_ModTableList compatibility.
// Sets order parameters.
public AMI_ArrayIteratorList::addOrder ( string $field, [ string $direction = '' ] ) returns AMI_ArrayIteratorList;
// Adds search condition.
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::addWhereDef ( string $expression ) returns AMI_ArrayIteratorList;
// Counts elements of an object.
public AMI_ArrayIteratorList::count ( ) returns int;
// Returns the current element.
// Excludes fields not from available list.
public AMI_ArrayIteratorList::filterFields ( $aFields ) returns array;
// Returns array of available fields.
public AMI_ArrayIteratorList::getAvailableFields ( [ bool $bAppendEventFields = null ] ) returns array;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::getColumns ( ) returns array;
// Returns an array with list keys.
public AMI_ArrayIteratorList::getKeys ( ) returns array;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::getMainTableAlias ( [ bool $bAsPrefix = null ] ) returns null;
// Get the number of found rows when bCalcFoundRows is true.
// Gets position of the applied element.
public AMI_ArrayIteratorList::getPosition ( string $fieldName, integer $appliedValue, integer $position ) returns integer;
// Returns primary key field name.
public AMI_ArrayIteratorList::getPrimaryKeyField ( ) returns string;
// Necessary for AMI_ModTableList compatibility.
public AMI_ArrayIteratorList::getQuery ( ) returns bool;
// Returns sort field.
public AMI_ArrayIteratorList::getSortField ( ) returns string;
// Returns TRUE if list model has passed column .
public AMI_ArrayIteratorList::hasColumn ( string $column, [ string $alias = '' ], [ bool $bAppendEventFields = TRUE ] ) returns bool;
// Returns the key of the current element.
public AMI_ArrayIteratorList::key ( ) returns integer;
// Loads data from array and init recordset.
// Fills array aData with the current page items.
public AMI_ArrayIteratorList::loadCurrentPage ( ) returns void;
// Move forward to the next element.
public AMI_ArrayIteratorList::next ( ) returns void;
// Rewinds the Iterator to the first element.
public AMI_ArrayIteratorList::rewind ( ) returns void;
// Seeks to a position.
public AMI_ArrayIteratorList::seek ( integer $position ) returns void;
// Sets limit parameters.
public AMI_ArrayIteratorList::setLimitParameters ( int $start, int $limit ) returns AMI_ArrayIteratorList;
// Sets module id.
public AMI_ArrayIteratorList::setModId ( string $modId ) returns void;
// Sorts aData list by field.
public AMI_ArrayIteratorList::sortList ( [ string $sortField = '' ], [ string $sort = null ] ) returns void;
// Forms an array with list keys.
public AMI_ArrayIteratorList::storeKeys ( [ string $keyField = false ] ) returns void;
// Checks if current position is valid.
public AMI_ArrayIteratorList::valid ( ) returns bool;
// Filter raw data array by conditions.
protected AMI_ArrayIteratorList::filterByConditions ( [ mixed $position = false ] ) returns void;
// Returns module id.
protected AMI_ArrayIteratorList::getModId ( ) returns string;
// Filter callback function.
protected AMI_ArrayIteratorList::_filterCallback ( $aItem ) returns bool;
}
Tags:
since 5.14.8
resource specblock_array_iterator/table/model/list AMI::getResource('specblock_array_iterator/table/model/list', array($IteratorTable))

• Class Methods

// Returns the active page number.
public getActivePage ( [ int $pageSize = 10 ], [ int $position = 0 ] ) returns int;
  • int $pageSize
    Number of items per page
  • int $position
    List position
// Returns module Id.
public getModId ( ) returns string;
// Returns the pages number.
public getPagesCount ( [ int $pageSize = 10 ] ) returns int;
  • int $pageSize
    Number of items per page