Documentation

Structure_Controller_Breadcrumbs extends Core_Controller
in package

Показ навигационной цепочки структуры сайта.

Доступные методы:

  • current($parentId) вывод потомков узла структуры $parentId
  • showProperties(TRUE) выводить значения дополнительных свойств, по умолчанию NULL
  • cache(TRUE|FALSE) использовать кэширование, по умолчанию TRUE
$Structure_Controller_Breadcrumbs = new Structure_Controller_Breadcrumbs( Core_Entity::factory('Site', 1) );
$Structure_Controller_Breadcrumbs
	->xsl(
		Core_Entity::factory('Xsl')->getByName('ХлебныеКрошки')
	)
	->show();
Tags
subpackage

Structure

version
7.x
author

Hostmake LLC

copyright

© 2005-2022 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_aProperties  : array<string|int, mixed>
List of properties
$_aProperty_Dirs  : array<string|int, mixed>
List of property directories
$_attributePrefix  : string
Attribute's prefix
$_breadcrumbs  : array<string|int, mixed>
List of breadcrumbs items
$_cacheTags  : array<string|int, mixed>
Cache tags
$_entities  : array<string|int, mixed>
List of children entities
$_entity  : Core_Entity
Entity
$_Informationsystems  : array<string|int, mixed>
List of information systems
$_mode  : string
Controller's mode
$_propertiesValues  : array<string|int, mixed>
Properties values
$_shownIDs  : array<string|int, mixed>
Shown IDs
$_tpl  : Tpl_Model
TPL
$_unlimitedProperties  : bool
Object has unlimited number of properties
$_vars  : array<string|int, mixed>
Variables/objects to the TPL-template
$_xsl  : Xsl_Model
XSL
__construct()  : mixed
Constructor.
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
addBreadcrumb()  : self
Add breadcrumb
addBreadcrumbs()  : self
Add breadcrumbs
addCacheSignature()  : self
Add additional signature for cache name
addCacheTag()  : self
Add Cache Tag
addEntities()  : self
Add enities
addEntity()  : self
Add a children entity
append()  : self
Append an element to an assigned array
applyForbiddenTags()  : self
Apply forbidden tags
assign()  : self
Assign variables/objects to the TPL-template
clearCacheTag()  : self
Clear Cache Tag
clearEntities()  : self
Clear enities
clearVars()  : self
Clear vars
get()  : string
Get HTML based by entities tree, use XSL $this->_xsl
getBreadcrumbs()  : array<string|int, mixed>
Get breadcrumbs
getCacheTags()  : array<string|int, mixed>
Get Cache Tags
getEntities()  : array<string|int, mixed>
Get enities
getEntity()  : object
Get entity
getShownIDs()  : array<string|int, mixed>
Get shown IDs
getStdObject()  : array<string|int, mixed>
Get ARRAY for entity and children entities
getTpl()  : Tpl_Model
Get TPL
getXml()  : string
Get XML for entity and children entities
getXsl()  : Xsl_Model
Get XSL
mode()  : self
Set mode
set()  : self
Run when writing data to inaccessible properties
setAttributePrefix()  : self
Change attributePrefix
setEntity()  : self
Set entity
setUnlimitedProperties()  : self
Set unlimitedProperties
show()  : self
Show built data
tpl()  : self
Set TPL
xsl()  : self
Set XSL
_addPropertyList()  : self
Create the tree of property dirs and properties

Properties

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('current', 'showProperties', 'showInformationsystem', 'showShop', 'showProducer', 'showForum', 'showMessage', 'showHelpdesk', 'cache', 'informationsystem_item_id', 'informationsystem_group_id', 'shop_item_id', 'shop_group_id', 'shop_producer_id', 'forum_category_id', 'forum_topic_id', 'forbiddenTags', 'message_topic_id', 'helpdesk_ticket_id')

$_aProperties

List of properties

protected array<string|int, mixed> $_aProperties = array()

$_aProperty_Dirs

List of property directories

protected array<string|int, mixed> $_aProperty_Dirs = array()

$_attributePrefix

Attribute's prefix

protected string $_attributePrefix = '_'

$_breadcrumbs

List of breadcrumbs items

protected array<string|int, mixed> $_breadcrumbs = array()

$_cacheTags

Cache tags

protected array<string|int, mixed> $_cacheTags = array()

$_entities

List of children entities

protected array<string|int, mixed> $_entities = array()

$_Informationsystems

List of information systems

protected array<string|int, mixed> $_Informationsystems = array()

$_mode

Controller's mode

protected string $_mode = 'json'

$_propertiesValues

Properties values

protected array<string|int, mixed> $_propertiesValues = array()

$_shownIDs

Shown IDs

protected array<string|int, mixed> $_shownIDs = array()

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

$_vars

Variables/objects to the TPL-template

protected array<string|int, mixed> $_vars = array()

Methods

addAllowedProperties()

Add additional allowed properties

public addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>

array of properties' names

Return values
self

addAllowedProperty()

Add additional allowed property

public addAllowedProperty(string $property) : self
Parameters
$property : string

property name

Return values
self

addBreadcrumb()

Add breadcrumb

public addBreadcrumb(mixed $oObject) : self
Parameters
$oObject : mixed
Return values
self

addBreadcrumbs()

Add breadcrumbs

public addBreadcrumbs(array<string|int, mixed> $aObjects) : self
Parameters
$aObjects : array<string|int, mixed>
Return values
self

addCacheSignature()

Add additional signature for cache name

public addCacheSignature(string $name) : self
Parameters
$name : string

name

Return values
self

addCacheTag()

Add Cache Tag

public addCacheTag(string $tagName) : self
Parameters
$tagName : string
Return values
self

addEntities()

Add enities

public addEntities(array<string|int, mixed> $aChildrenEntities) : self
Parameters
$aChildrenEntities : array<string|int, mixed>

entities

Return values
self

append()

Append an element to an assigned array

public append(mixed $varname, mixed $var) : self
Parameters
$varname : mixed
$var : mixed
Return values
self

applyForbiddenTags()

Apply forbidden tags

public applyForbiddenTags(object $oEntity) : self
Parameters
$oEntity : object
Return values
self

assign()

Assign variables/objects to the TPL-template

public assign(mixed $varname, mixed $var) : self
Parameters
$varname : mixed
$var : mixed
Return values
self

clearCacheTag()

Clear Cache Tag

public clearCacheTag() : self
Return values
self

clearEntities()

Clear enities

public clearEntities() : self
Return values
self

clearVars()

Clear vars

public clearVars() : self
Return values
self

get()

Get HTML based by entities tree, use XSL $this->_xsl

public get() : string
Tags
see
getXml()
hostcms-event

Core_Controller.onBeforeShow

hostcms-event

Core_Controller.onAfterShow

Return values
string

getBreadcrumbs()

Get breadcrumbs

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

getCacheTags()

Get Cache Tags

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

getEntities()

Get enities

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

getEntity()

Get entity

public getEntity() : object
Return values
object

getShownIDs()

Get shown IDs

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

getStdObject()

Get ARRAY for entity and children entities

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

getXml()

Get XML for entity and children entities

public getXml() : string
Return values
string

mode()

Set mode

public mode(string $mode) : self
Parameters
$mode : string
Return values
self

set()

Run when writing data to inaccessible properties

public set(string $property, string $value) : self
Parameters
$property : string

property name

$value : string

property value

Return values
self

setAttributePrefix()

Change attributePrefix

public setAttributePrefix(string $attributePrefix) : self
Parameters
$attributePrefix : string
Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self

show()

Show built data

public show() : self
Tags
hostcms-event

Structure_Controller_Breadcrumbs.onBeforeRedeclaredShow

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddInformationsystemItem

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddInformationsystemGroups

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddShopItem

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddShopGroups

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddStructure

hostcms-event

Structure_Controller_Breadcrumbs.onAfterAddBreadcrumbs

Return values
self

_addPropertyList()

Create the tree of property dirs and properties

protected _addPropertyList(int $parent_id, object $parentObject) : self
Parameters
$parent_id : int

property group ID

$parentObject : object
Return values
self

Search results