PHP Класс FlatCategoryModule, vanilla

Наследование: extends Gdn_Module
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$categoryID Category identifier. Can be the slug or the category's ID.
$filter Filter output by name.
$limit Limit on the number of categories displayed.

Открытые методы

Метод Описание
__construct ( string | Gdn_Controller $sender = '', boolean | string $applicationFolder = false ) FlatCategoryModule constructor.
assetTarget ( ) : string Returns the name of the asset where this component should be rendered.
getCategory ( ) : array | null Get data for the configured category.
getChildren ( ) : array | null Get a list of immediate children for the configured category.
getFilter ( ) : null | string Get the value to be used for filtering categories by name, if any.
getLimit ( ) : integer Get the configured record limit.
toString ( ) : string Returns the component as a string to be rendered to the screen.

Описание методов

__construct() публичный Метод

FlatCategoryModule constructor.
public __construct ( string | Gdn_Controller $sender = '', boolean | string $applicationFolder = false )
$sender string | Gdn_Controller
$applicationFolder boolean | string

assetTarget() публичный Метод

Returns the name of the asset where this component should be rendered.
public assetTarget ( ) : string
Результат string

getCategory() публичный Метод

Get data for the configured category.
public getCategory ( ) : array | null
Результат array | null Array if the configured category is valid. Otherwise, null.

getChildren() публичный Метод

Get a list of immediate children for the configured category.
public getChildren ( ) : array | null
Результат array | null

getFilter() публичный Метод

Get the value to be used for filtering categories by name, if any.
public getFilter ( ) : null | string
Результат null | string

getLimit() публичный Метод

Get the configured record limit.
public getLimit ( ) : integer
Результат integer

toString() публичный Метод

Returns the component as a string to be rendered to the screen.
public toString ( ) : string
Результат string

Описание свойств

$categoryID публичное свойство

Category identifier. Can be the slug or the category's ID.
public $categoryID

$filter публичное свойство

Filter output by name.
public $filter

$limit публичное свойство

Limit on the number of categories displayed.
public $limit