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

The AMI_Module_FilterModelAdm class

AMI_Filter
   |
   --AMI_Module_FilterModelAdm

• Introduction

AMI_Module module item list component filter model.

• Class synopsis

AMI_Module_FilterModelAdm extends AMI_Filter {
/* Properties */
// Common filter fields
protected array $aCommonFields = array('datefrom', 'dateto', 'header');
/* Inherited Properties */
// Array of dropped fields
protected AMI_Filter::$aDroppedFields = array();
/* Methods */
// Constructor.
public __construct ( ) returns AMI_Module_FilterModelAdm;
// Handle id_page filter custom logic.
protected processFieldData ( string $field, $aData ) returns array;
/* Inherited Methods */
// Returns filter field value.
public static AMI_Filter::getFieldValue ( string $name, [ mixed $default = null ] ) returns mixed;
// Adds view field.
public AMI_Filter::addViewField ( $aField ) returns AMI_Filter;
// Drops view fields.
public AMI_Filter::dropViewFields ( $aNames ) returns AMI_Filter;
// Returns item id.
public AMI_Filter::getId ( ) returns mixed;
// Returns module Id.
public AMI_Filter::getModId ( ) returns string;
// Sets module Id.
public AMI_Filter::setModId ( string $modId ) returns void;
// For custom data manipulation.
protected AMI_Filter::processFieldData ( string $field, $aData ) returns array;
}
Tags:
todo Implement system wide filter for id_page
abstract
since 5.14.4

• Class Properies

protected array $aCommonFields

Common filter fields

• Class Methods

// Constructor.
public __construct ( ) returns AMI_Module_FilterModelAdm;
// Handle id_page filter custom logic.
protected processFieldData ( string $field, $aData ) returns array;
  • string $field
    Field name
  • array $aData
    Filter data