The KbItemProps_TableList class

AMI_ModTableList
   |
   --KbItemProps_TableList

• Introduction

Kb props table list model.

• Class synopsis

KbItemProps_TableList extends AMI_ModTableList {

/* Inherited Properties */

// Recordset columns

protected AMI_ModTableList::$aColumns = array();

// Expression columns struct

protected AMI_ModTableList::$aExpressionColumns = array();

// Do calculate found rows

protected AMI_ModTableList::$bCalcFoundRows = false;

// Number of found rows (works only when bCalcFoundRows is true).

protected AMI_ModTableList::$numberOfFoundRows = 0;

// DB_Query object

protected AMI_ModTableList::$oQuery;

// DB recordset

protected AMI_ModTableList::$oRS;

// AMI_ModTable object

protected AMI_ModTableList::$oTable;

/* Inherited Methods */

// Initializing table list data.

public AMI_ModTableList::__construct ( $oTable, $oQuery ) returns AMI_ModTableList;

// Set the SQL_CALC_FOUND_ROWS selection flag.

public AMI_ModTableList::addCalcFoundRows ( [ bool $bState = true ] ) returns this;

// Repairs item position.

public AMI_ModTableList::addColumn ( mixed $name, [ mixed $model = '' ] ) returns AMI_ModTableList;

// Adds several columns at time for list selection.

public AMI_ModTableList::addColumns ( $aColumns, [ string $model = '' ] ) returns AMI_ModTableList;

// Adds expression column to list selection.

public AMI_ModTableList::addExpressionColumn ( string $name, DB_Snippet|string $expression, [ string $model = '' ] ) returns AMI_ModTableList;

// Adds expression to selection.

public AMI_ModTableList::addExpressionField ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Adds grouping.

public AMI_ModTableList::addGrouping ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Adds having definition.

public AMI_ModTableList::addHavingDef ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Adds navigation columns.

public AMI_ModTableList::addNavColumns ( ) returns AMI_ModTableList;

// Adds order.

public AMI_ModTableList::addOrder ( string $field, [ string $direction = '' ] ) returns AMI_ModTableList;

// Adds item search condition.

public AMI_ModTableList::addSearchCondition ( $aCondition ) returns AMI_ModTableItem;

// Adds columns to SELECT from table in DB_Query.

public AMI_ModTableList::addSelectedFields ( $oQuery, [ string $prefix = '' ] ) returns void;

// Adds where definition.

public AMI_ModTableList::addWhereDef ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Counts elements of an object.

public AMI_ModTableList::count ( ) returns int;

// Returns the current element.

public AMI_ModTableList::current ( ) returns AMI_ModTableItem;

// Deletes column from list selection.

public AMI_ModTableList::dropColumn ( string $name, [ string $model = '' ] ) returns AMI_ModTableList;

// Exludes fields not from available list.

public AMI_ModTableList::filterFields ( $aFields, [ string $modelAlias = '' ] ) returns array;

// Returns array of available fields.

public AMI_ModTableList::getAvailableFields ( [ bool $bAppendEventFields = true ] ) returns array;

// Returns field name with its alias or expression.

public AMI_ModTableList::getColumn ( string $column, [ string $alias = '' ], [ bool $bAppendEventFields = TRUE ] ) returns bool;

// Returns real field name by its alias.

public AMI_ModTableList::getFieldName ( string $alias ) returns string;

// Make the query and return recordset for selected fields.

public AMI_ModTableList::getListRecordset ( ) returns DB_iRecordset;

// Returns main table alias.

public AMI_ModTableList::getMainTableAlias ( [ bool $bAsPrefix = false ] ) returns string;

// Get the number of found rows when bCalcFoundRows is true.

public AMI_ModTableList::getNumberOfFoundRows ( ) returns AMI_ModTableList;

// Gets position of the applied element.

public AMI_ModTableList::getPosition ( string $fieldName, integer $appliedValue, integer $position ) returns integer;

// Returns table object.

public AMI_ModTableList::getTable ( ) returns AMI_ModTable;

// Returns TRUE if list model has passed column (including expression columns).

public AMI_ModTableList::hasColumn ( string $column, [ string $alias = '' ], [ bool $bAppendEventFields = TRUE ] ) returns bool;

// Returns the key of the current element.

public AMI_ModTableList::key ( ) returns mixed;

// Called before recordset initialization. Allows to add additional list query parameters.

public AMI_ModTableList::load ( ) returns void;

// Move forward to next element.

public AMI_ModTableList::next ( ) returns void;

// Forces list to collect page sublinks after all data loaded.

public AMI_ModTableList::requestModLinks ( ) returns AMI_ModTableList;

// Rewinds the Iterator to the first element.

public AMI_ModTableList::rewind ( ) returns void;

// Seeks to a position.

public AMI_ModTableList::seek ( int $position ) returns bool;

// Sets having definition.

public AMI_ModTableList::setHavingDef ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Specifies to autoexlude or not invalid columns during AMI_ModTableList::addColumns().

public AMI_ModTableList::setInvalidColumnExclusion ( bool $bExclude ) returns AMI_ModTableList;

// Sets a dependent model and loads its data to a new column $fieldAlias after the list data was loaded.

public AMI_ModTableList::setLateDataBinding ( string $modelField, string $fieldAlias, string $bindedModel, string $bindedField, [ $oWhereDefSnippet = null ], [ string $bindedKey = null ], [ string $default = null ], [ $bindEnumerating = array() ] ) returns AMI_ModTableList;

// Sets limit parameters.

public AMI_ModTableList::setLimitParameters ( int $start, int $limit ) returns AMI_ModTableList;

// Sets where definition.

public AMI_ModTableList::setWhereDef ( DB_Snippet|string $expression ) returns AMI_ModTableList;

// Checks if current position is valid.

public AMI_ModTableList::valid ( ) returns bool;

// Destructor.

public AMI_ModTableList::__destruct ( ) returns void;

// Returns module id.

protected AMI_ModTableList::getModId ( ) returns string;

}

Tags:

since	6.0.2
resource	{$modId}/table/model/list AMI::getResourceModel('{$modId}/table')->getList()*