Documentation

Sesha_View_List extends Sesha_View_Base
in package

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.

Tags
author

Ralf Lang lang@b1-systems.de

category

Horde

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

$title  : string
The page title
__construct()  : mixed
allCategories()  : array<string|int, mixed>
Retrieves all categories from driver.
columnHeaders()  : mixed
Builds column header array out of the list of properties and default attributes.
properties()  : mixed
Returns the list of property objects to display.
stock()  : mixed
Returns the items which match the category or search criteria.

Properties

$title

The page title

public string $title = ''
Tags
access

public

Methods

__construct()

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>
Return values
mixed —

allCategories()

Retrieves all categories from driver.

public allCategories() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of Sesha_Entity_Category objects.

columnHeaders()

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

protected columnHeaders(mixed $sortdir, mixed $sortby) : mixed
Parameters
$sortdir : mixed
$sortby : mixed
Return values
mixed —

properties()

Returns the list of property objects to display.

protected properties([mixed $propertyIds = array() ]) : mixed
Parameters
$propertyIds : mixed = array()
Return values
mixed —

stock()

Returns the items which match the category or search criteria.

protected stock([mixed $filters = array() ]) : mixed
Parameters
$filters : mixed = array()
Return values
mixed —

Search results