Amiro.CMS API Reference
 Amiro.Ru / Manual

Classes:
Model
   AMI_ArrayIterator
   AMI_ArrayIteratorItem
   AMI_ArrayIteratorList
   AMI_CatModTable
   AMI_CatModTableItem
   AMI_CatModTableList
   AMI_CatModule_FilterModelAdm
   AMI_CatModule_TableItemModifier
   AMI_Filter
   AMI_ModSpecblock_ArrayIterator
   AMI_ModSpecblock_ArrayIteratorItem
   AMI_ModSpecblock_ArrayIteratorList
   AMI_ModTable
   AMI_ModTableItem
   AMI_ModTableItemException
   AMI_ModTableItemMeta
   AMI_ModTableItemModifier
   AMI_ModTableList
   AMI_Module_FilterModelAdm
   AMI_Module_TableItem
   AMI_Module_TableItemModifier
Controller
   AMI_CatModule_FilterAdm
   AMI_CatModule_FormAdm
   AMI_CatModule_ListActionsAdm
   AMI_CatModule_ListAdm
   AMI_CatModule_ListGroupActionsAdm
   AMI_CustomComponent
   AMI_ModCatsFrn
   AMI_ModComponent
   AMI_ModDetails
   AMI_ModEmptyFrn
   AMI_ModEmptyView
   AMI_ModFilter
   AMI_ModFilterAdm
   AMI_ModForm
   AMI_ModFormAdm
   AMI_ModItemsFrn
   AMI_ModList
   AMI_ModListActions
   AMI_ModListAdm
   AMI_ModListAdmCommon
   AMI_ModListGroupActions
   AMI_ModSpecblock
   AMI_ModSpecblockList
   AMI_Module_FilterAdm
   AMI_Module_FormAdm
   AMI_Module_ListActionsAdm
   AMI_Module_ListAdm
   AMI_Module_ListGroupActionsAdm
View
   AMI_CatModule_FilterViewAdm
   AMI_CatModule_FormViewAdm
   AMI_CatModule_ListViewAdm
   AMI_CustomComponentView
   AMI_ModCatsView
   AMI_ModCommonViewFrn
   AMI_ModDetailsView
   AMI_ModFilterView
   AMI_ModFilterViewAdm
   AMI_ModFormView
   AMI_ModFormViewAdm
   AMI_ModFormViewFrn
   AMI_ModItemsView
   AMI_ModListView
   AMI_ModListView_JSON
   AMI_ModPlaceholderView
   AMI_ModSpecblockListView
   AMI_ModSubitemsView
   AMI_Module_FilterViewAdm
   AMI_Module_FormViewAdm
   AMI_Module_ListViewAdm
   AMI_View
   AMI_ViewEmpty
AMI_ModRules
Orphus
Loading search...

The AMI_iModTableList interface

• Introduction

Module component list model interface.

• Interface synopsis

AMI_iModTableList {
/* Methods */
// Sets the SQL_CALC_FOUND_ROWS selection flag.
public addCalcFoundRows ( ) returns this;
// Adds several columns at time for list selection.
public addColumns ( $aColumns, [ string $model = '' ] ) returns AMI_ModTableList;
// Adds order.
public addOrder ( string $field, [ string $direction = '' ] ) returns AMI_ModTableList;
// Exludes fields not from available list.
public filterFields ( $aFields ) returns array;
// Returns array of available fields.
public getAvailableFields ( [ bool $bAppendEventFields = true ] ) returns array;
// Get the number of found rows when bCalcFoundRows is true.
public getNumberOfFoundRows ( ) returns AMI_ModTableList;
// Gets position of the applied element.
public getPosition ( string $fieldName, integer $appliedId, integer $position ) returns integer;
// Loads data from table and init recordset.
public load ( ) returns AMI_ModTableList;
// Sets limit parameters.
public setLimitParameters ( int $start, int $limit ) returns AMI_ModTableList;
}

• Interface Details

Use AMI_ModTableList children, interface usage will be described later.
Tags:
see AmiSample_TableList
since 5.10.0

• Interface Methods

// Sets the SQL_CALC_FOUND_ROWS selection flag.
public addCalcFoundRows ( ) returns this;
// Adds several columns at time for list selection.
public addColumns ( $aColumns, [ string $model = '' ] ) returns AMI_ModTableList;
  • array $aColumns
    Array of column field names, may be in format AMI_ModTable::getAvailableFields()
  • string $model
    Dependent model alias
// Adds order.
public addOrder ( string $field, [ string $direction = '' ] ) returns AMI_ModTableList;
  • string $field
    Field name
  • string $direction
    Order
// Exludes fields not from available list.
public filterFields ( $aFields ) returns array;
  • array $aFields
    Fields
Tags:
since 5.12.0
// Returns array of available fields.
public getAvailableFields ( [ bool $bAppendEventFields = true ] ) returns array;
  • bool $bAppendEventFields
    Fire 'on_get_available_fields' event to append extension fields
// Get the number of found rows when bCalcFoundRows is true.
public getNumberOfFoundRows ( ) returns AMI_ModTableList;
// Gets position of the applied element.
public getPosition ( string $fieldName, integer $appliedId, integer $position ) returns integer;
  • string $fieldName
    Field name to search in
  • integer $appliedId
    Field value of the applied element
  • integer $position
    Initial position
// Loads data from table and init recordset.
public load ( ) returns AMI_ModTableList;
// Sets limit parameters.
public setLimitParameters ( int $start, int $limit ) returns AMI_ModTableList;
  • int $start
    Start
  • int $limit
    Limit