The Hyper_AmiClean_ListViewAdm class

AMI_View
   |
   --AMI_ModPlaceholderView
      |
      --AMI_ModListView
         |
         --AMI_ModListView_JSON
            |
            --Hyper_AmiClean_ListViewAdm

• Introduction

Base hypermodule admin list component view.

• Class synopsis

Hyper_AmiClean_ListViewAdm extends AMI_ModListView_JSON {

/* Inherited Properties */

// Columns footers

protected AMI_ModListView_JSON::$aColumnFooters = array();

// Columns with fixed width

protected AMI_ModListView_JSON::$aFixedWidthColumns = array();

// Tensile columns

protected AMI_ModListView_JSON::$aTensileColumns = array();

// Column rules object

protected AMI_ModListView::$aColumnFormatters = array();

// Column layouts

protected AMI_ModListView::$aColumnLayouts = array();

// Columns array

protected AMI_ModListView::$aColumns = array();

// Columns types

protected AMI_ModListView::$aColumnTypes = array();

// List default elements template (placeholders)

protected AMI_ModListView::$aPlaceholders = array( '#list_header', '#flags', 'position', 'public', 'flags', '#common', 'date_created', 'cat_header', 'common', '#columns', 'columns', '#actions', 'front_view', 'edit', 'actions', 'list_header' );

// Sort columns list

protected AMI_ModListView::$aSortColumns = array();

// Body column set name

protected AMI_ModListView::$bodyItemSet = 'body_item';

// Body row set name

protected AMI_ModListView::$bodyRowSet = 'body_row';

// Body set name

protected AMI_ModListView::$bodySet = 'body';

// Footer set name

protected AMI_ModListView::$footerSet = 'footer';

// Header column set name

protected AMI_ModListView::$headerItemSet = 'header_item';

// Header row set name

protected AMI_ModListView::$headerRowSet = 'header_row';

// Header set name

protected AMI_ModListView::$headerSet = 'header';

// List set name

protected AMI_ModListView::$listSet = 'list';

// Model typification

protected AMI_ModListView::$oModel;

// Order column

protected AMI_ModListView::$orderColumn = 'id';

// Order column direction

protected AMI_ModListView::$orderDirection = 'asc';

// Locale

protected AMI_View::$aLocale = array();

// Scope

protected AMI_View::$aScope = array();

// Locale file name

protected AMI_View::$localeFileName = '';

// Template block name

protected AMI_View::$tplBlockName = '';

// Template file name

protected AMI_View::$tplFileName = '';

/* Inherited Methods */

// Adds standard action columns.

public AMI_ModListView_JSON::addActionColumns ( ) returns void;

// Adds footer for corresponding column.

public AMI_ModListView_JSON::addColumnFooter ( string $column, [ string $aData = array() ] ) returns AMI_ModListView_JSON;

// Allows modify the data line of the list.

public AMI_ModListView_JSON::get ( ) returns void;

// Event handler.

public AMI_ModListView_JSON::handleActionCell ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Returns columns footers.

protected AMI_ModListView_JSON::getColumnFooters ( ) returns array;

// Returns tensile columns.

protected AMI_ModListView_JSON::getTensileColumns ( ) returns array;

// Sets tensile column.

protected AMI_ModListView_JSON::setColumnTensility ( string $column, [ bool $isTensile = true ] ) returns AMI_ModListView_JSON;

// Add column into array.

public AMI_ModListView::addColumn ( string $column, [ string $placeholderPos = '' ] ) returns AMI_ModListView;

// Adds column (if not added yet) and its type for corresponding column.

public AMI_ModListView::addColumnType ( string $column, string $type ) returns AMI_ModListView_JSON;

// Adding order.

public AMI_ModListView::addOrder ( string $column, [ bool $direction = true ] ) returns AMI_ModListView;

// Adds column formatter.

public AMI_ModListView::formatColumn ( string $column, callback $callback, [ $aArgs = array() ] ) returns AMI_ModListView;

// Allows modify the value of a cell in the list.

public AMI_ModListView::get ( ) returns void;

// Return columns for list model.

public AMI_ModListView::getColumns ( ) returns array;

// Getting sorting order.

public AMI_ModListView::getOrder ( ) returns string;

// Getting sorting direction.

public AMI_ModListView::getOrderDirection ( ) returns string;

// Remove column.

public AMI_ModListView::removeColumn ( string $column ) returns AMI_ModListView;

// Sets fixed column alignment.

public AMI_ModListView::setColumnAlign ( string $column, string $align ) returns AMI_ModListView;

// Sets fixed column class name.

public AMI_ModListView::setColumnClass ( string $column, string $class ) returns AMI_ModListView;

// Sets fixed column layout.

public AMI_ModListView::setColumnLayout ( string $column, $aLayout ) returns AMI_ModListView;

// Sets fixed column width.

public AMI_ModListView::setColumnWidth ( string $column, string $width ) returns AMI_ModListView;

// Adds sort columns.

protected AMI_ModListView::addSortColumns ( $aColumns ) returns AMI_ModListView;

// Displays image in separate column if (bool)value is TRUE.

protected AMI_ModListView::fmtColIcon ( mixed $value, $aArgs ) returns string;

// Date/time formatter.

protected AMI_ModListView::fmtDateTime ( string $value, $aArgs ) returns mixed;

// Encodes column value.

protected AMI_ModListView::fmtHTMLEncode ( mixed $value, $aArgs ) returns mixed;

// Extended Date/time formatter. For FMT_DATEs Replaces yesterday date by localized word "yesterday" (today, tommorow).

protected AMI_ModListView::fmtHumanDateTime ( string $value, $aArgs ) returns mixed;

// Replaces column value by its localized caption.

protected AMI_ModListView::fmtLocaleCaption ( mixed $value, [ $aArgs = array() ] ) returns mixed;

// Strips tags from column value.

protected AMI_ModListView::fmtStripTags ( mixed $value, $aArgs ) returns mixed;

// Truncates column value.

protected AMI_ModListView::fmtTruncate ( mixed $value, $aArgs ) returns mixed;

// Model typification.

protected AMI_ModListView::_setModel ( object $oModel ) returns AMI_ModListView;

// Constructor.

public AMI_ModPlaceholderView::__construct ( ) returns AMI_ModPlaceholderView;

// Add new field placeholders into placeholder list using AMI_ModPlaceholderView::putPlaceholder() without sections.

public AMI_ModPlaceholderView::addPlaceholders ( $aPlaceholders ) returns AMI_ModPlaceholderView;

// Puts placeholder into required position.

public AMI_ModPlaceholderView::putPlaceholder ( string $name, [ string $positions = '' ], [ bool $isSection = false ] ) returns bool|int;

// Constructor.

public AMI_View::__construct ( ) returns AMI_View;

// Adds locale.

public AMI_View::addLocale ( $aLocale, [ bool $doOverwrite = true ] ) returns AMI_View;

// Adds script code.

public AMI_View::addScriptCode ( string $code ) returns AMI_View;

// Adds script file.

public AMI_View::addScriptFile ( string $file ) returns AMI_View;

// Returns view data.

public AMI_View::get ( ) returns mixed;

// Initialize, processing after setting model.

public AMI_View::init ( ) returns AMI_View;

// Adds locale from resource.

public AMI_View::setModel ( mixed $oModel, [ $aLocale = array() ], string $path ) returns AMI_View;

// Set module id.

public AMI_View::setModId ( string $modId ) returns void;

// Sets view scope.

public AMI_View::setScope ( $aScope ) returns AMI_View;

protected AMI_View::addOpenGraphTags ( $header, $description, [ $image = '' ] ) returns void;

// Returns module id.

protected AMI_View::getModId ( ) returns string;

// Returns module specific locale path.

protected AMI_View::getModLocalePath ( ) returns string;

// Returns prepared view scope.

protected AMI_View::getScope ( string $type, [ $aScope = array() ] ) returns array;

// Returns template object.

protected AMI_View::getTemplate ( ) returns AMI_iTemplate;

// Parses block template and returns the result as a string.

protected AMI_View::parse ( string $setName, [ $aScope = array() ] ) returns string;

// Sets up model object.

protected AMI_View::_setModel ( mixed $oModel ) returns AMI_View;

}

Tags:

abstract
since	6.0.2