API Documentation
\

\Sesha_View_List

The Sesha_View_List class wraps the list view logic to keep the client pages simple.

Available fields:

  • header: (string) The header text related to the listing table.
  • selectedCategories: (array) The selected categories.
  • columnHeaders: (array) The columns structure for the result table.
  • shownProperties: (array) The list of property objects to use.
  • shownStock: (array) The stock display matrix

Copyright 2012-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
__construct()
allCategories()
$title
No constants found
columnHeaders()
properties()
stock()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$title

$title : string

The page title

Type

string

Methods

__construct()

__construct(array  $config)

Parameters

array $config

allCategories()

allCategories() : array

Retrieves all categories from driver.

Returns

array —

List of Sesha_Entity_Category objects.

columnHeaders()

columnHeaders(  $sortdir,   $sortby)

Builds column header array out of the list of properties and default attributes.

Parameters

$sortdir
$sortby

properties()

properties(  $propertyIds = array())

Returns the list of property objects to display.

Parameters

$propertyIds

stock()

stock(  $filters = array())

Returns the items which match the category or search criteria.

Parameters

$filters