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_iModTable interface

• Introduction

Module component table model interface.

• Interface synopsis

AMI_iModTable {
/* Methods */
// Returns item model object and load data for key field param.
public find ( int $id, [ $aFields = array('*') ] ) returns AMI_ModTableItem;
// Returns item model object and load data for non-primary key field.
public findByFields ( $aSearchCondition, [ $aFields = array('*') ] ) returns AMI_ModTableItem;
// Returns array of available fields.
public getAvailableFields ( [ bool $bAppendEventFields = true ] ) returns array;
// Returns item model object.
public getItem ( [ string $type = '' ] ) returns AMI_ModTableItem;
// Returns list model object.
public getList ( [ string $type = '' ] ) returns AMI_ModTableList;
// Returns table fields structure.
public getTableFieldsData ( ) returns array;
// Checks if model has a field.
public hasField ( string $name, [ bool $bAppendEventFields = false ] ) returns bool;
// Set module id.
public setModId ( mixed $id ) returns void;
}
Tags:
see AmiSample_Table
since 5.10.0

• Interface Methods

// Returns item model object and load data for key field param.
public find ( int $id, [ $aFields = array('*') ] ) returns AMI_ModTableItem;
  • int $id
    Primary key value
  • array $aFields
    Fields to load (since 5.12.8)
Tags:
see AMI_ModTableItem::addFields() for $aFields parameter explanation
// Returns item model object and load data for non-primary key field.
public findByFields ( $aSearchCondition, [ $aFields = array('*') ] ) returns AMI_ModTableItem;
  • array $aSearchCondition
    Filter array key => value
  • array $aFields
    Fields to load (since 5.12.8)
// Returns array of available fields.
public getAvailableFields ( [ bool $bAppendEventFields = true ] ) returns array;
  • bool $bAppendEventFields
    Fire 'on_get_available_fields' event to append extension fields
// Returns item model object.
public getItem ( [ string $type = '' ] ) returns AMI_ModTableItem;
  • string $type
    Postfix for 'on_query_add_joined_columns' event
// Returns list model object.
public getList ( [ string $type = '' ] ) returns AMI_ModTableList;
  • string $type
    Postfix for 'on_query_add_joined_columns' event
// Returns table fields structure.
public getTableFieldsData ( ) returns array;
// Checks if model has a field.
public hasField ( string $name, [ bool $bAppendEventFields = false ] ) returns bool;
  • string $name
    Field name in table
  • bool $bAppendEventFields
    Fire 'on_get_available_fields' event to append extension fields
// Set module id.
public setModId ( mixed $id ) returns void;
  • mixed $id
    Module Id.