Documentation

Informationsystem_Controller_Show extends Core_Controller
in package

HostCMS

Informationsystem

Показ информационной системы.

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

group($id) идентификатор информационной группы, если FALSE, то вывод информационных элементов осуществляется из всех групп
subgroups(TRUE|FALSE) отображать товары из подгрупп, доступно при указании в group() идентификатора родительской группы, по умолчанию FALSE
groupsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств групп, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
groupsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств групп информационных элементов, по умолчанию TRUE
propertiesForGroups(array()) устанавливает дополнительное ограничение на вывод значений дополнительных свойств групп для массива идентификаторов групп.
groupsMode('tree') режим показа групп, может принимать следующие значения: none - не показывать группы, tree - показывать дерево групп и все группы на текущем уровне (по умолчанию), all - показывать все группы.
item(123) идентификатор показываемого информационного элемента
itemsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств информационных элементов, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
sortPropertiesValues(TRUE|FALSE) сортировать значения дополнительных свойств, по умолчанию TRUE.
itemsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств информационных элементов, по умолчанию TRUE
commentsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств комментариев, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
commentsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств комментариев, по умолчанию TRUE.
groupsMedia(TRUE|FALSE) выводить значения библиотеки файлов для групп информационной системы, по умолчанию FALSE
itemsMedia(TRUE|FALSE) выводить значения библиотеки файлов для информационных элементов, по умолчанию FALSE
addFilter() добавить условие отобра информационных элементов, может задавать условие отобра по значению свойства ->addFilter('property', 17, '=', 1)
comments(TRUE|FALSE) показывать комментарии для выбранных информационных элементов, по умолчанию FALSE
commentsRating(TRUE|FALSE) показывать оценки комментариев для выбранных информационных элементов, по умолчанию FALSE
votes(TRUE|FALSE) показывать рейтинг элемента, по умолчанию TRUE
tags(TRUE|FALSE) выводить метки
calculateCounts(TRUE|FALSE) вычислять общее количество информационных элементов и групп в корневой группе, по умолчанию FALSE
siteuser(TRUE|FALSE) показывать данные о пользователе сайта, связанного с выбранным информационным элементом, по умолчанию TRUE
siteuserProperties(TRUE|FALSE) выводить значения дополнительных свойств пользователей сайта, по умолчанию FALSE
orderBy('informationsystem_items.name', 'ASC') задает направление сортировки информационных элементов
offset($offset) смещение, с которого выводить информационные элементы. По умолчанию 0
limit($limit) количество выводимых элементов
page(2) текущая страница, по умолчанию 0, счет ведется с 0
part($int) номер отображаемой части информационного элемента
parts(TRUE|FALSE) использовать разделение текста на части через pagebreak, по умолчанию TRUE
pattern($pattern) шаблон разбора данных в URI, см. __construct()
tag($path) путь тега, с использованием которого ведется отбор информационных элементов
cache(TRUE|FALSE) использовать кэширование, по умолчанию TRUE
itemsActivity('active'|'inactive'|'all') отображать элементы: active - только активные, inactive - только неактивные, all - все, по умолчанию - active
groupsActivity('active'|'inactive'|'all') отображать группы: active - только активные, inactive - только неактивные, all - все, по умолчанию - active
commentsActivity('active'|'inactive'|'all') отображать комментарии: active - только активные, inactive - только неактивные, all - все, по умолчанию - active
calculateTotal(TRUE|FALSE) вычислять общее количество найденных, по умолчанию TRUE
showPanel(TRUE|FALSE) показывать панель быстрого редактирования, по умолчанию TRUE
addAllowedTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, разрешенных к передаче в генерируемый XML
addForbiddenTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, запрещенных к передаче в генерируемый XML
getItemDataCallback($callback) callback-функция для обработки массива товаров для метода getData()/getJson(), по умолчанию _getItemData() текущего контроллера
getGroupDataCallback($callback) callback-функция для обработки массива групп для метода getData()/getJson(), по умолчанию _getGroupData() текущего контроллера

Устаревшие методы:

groupsForbiddenTags(array('description')) массив тегов групп, запрещенных к передаче в генерируемый XML
itemsForbiddenTags(array('description')) массив тегов информационных элементов, запрещенных к передаче в генерируемый XML

Доступные свойства:

total общее количество доступных для отображения записей
patternParams массив данных, извелеченных из URI при применении pattern

Доступные пути для методов addAllowedTags/addForbiddenTags:

'/' или '/informationsystem' Информационная система
'/informationsystem/informationsystem_group' Группы информационной системы
'/informationsystem/informationsystem_item' Информационные элементы
'/informationsystem/tag' Примененный Tag для фильтрации
'/informationsystem/informationsystem_group_properties/property' Свойство в списке свойств группы
'/informationsystem/informationsystem_group_properties/property_dir' Раздел свойств в списке свойств группы
'/informationsystem/informationsystem_item_properties/property' Свойство в списке свойств информационного элемента
'/informationsystem/informationsystem_item_properties/property_dir' Раздел свойств в списке свойств информационного элемента


$Informationsystem_Controller_Show = new Informationsystem_Controller_Show(
	Core_Entity::factory('Informationsystem', 1)
);

$Informationsystem_Controller_Show ->xsl( Core_Entity::factory('Xsl')->getByName('СписокНовостейНаГлавной') ) ->limit(5) ->show();

Properties

$_aComment_Properties : array<string|int, mixed>: List of properties for item
$_aComment_Property_Dirs : array<string|int, mixed>: List of property directories for item
$_aFilterProperties : array<string|int, mixed>: Array of Properties conditions, see addFilter()
$_aGroup_Properties : array<string|int, mixed>: List of properties for group
$_aGroup_Property_Dirs : array<string|int, mixed>: List of property directories for group
$_aGroupTree : null|array<string|int, mixed>: Groups Tree For fillInformationsystemGroups()
$_aInformationsystem_Groups : array<string|int, mixed>: List of groups of information systems
$_aItem_Properties : array<string|int, mixed>: List of properties for item
$_aItem_Property_Dirs : array<string|int, mixed>: List of property directories for item
$_allowedProperties : array<string|int, mixed>: Allowed object properties
$_allowedTags : array<string|int, mixed>: Allowed tags for specified elements
$_aSiteuserGroups : array<string|int, mixed>: Array of siteuser's groups allowed for current siteuser
$_attributePrefix : string: Attribute's prefix
$_cacheApplyForbiddenAllowedTags : array<string|int, mixed>: Cache for applyForbiddenAllowedTags
$_cacheName : string: Cache name
$_cacheTags : array<string|int, mixed>: Cache tags
$_entities : array<string|int, mixed>: List of children entities
$_entity : Core_Entity: Entity
$_errorCode : int|null: Error code
$_forbiddenTags : array<string|int, mixed>: Forbidden tags for specified elements
$_Informationsystem_Groups : Informationsystem_Group_Model: Information system's group object
$_Informationsystem_Items : Informationsystem_Item_Model: Information system's items object
$_mode : string: Controller's mode
$_oTag : null|Tag_Model: Current Tag
$_propertiesValues : array<string|int, mixed>: Properties values
$_seoGroupDescription : mixed
$_seoGroupH1 : mixed
$_seoGroupKeywords : mixed
$_seoGroupTitle : mixed
$_seoItemDescription : mixed
$_seoItemH1 : mixed
$_seoItemKeywords : mixed
$_seoItemTitle : mixed
$_shownIDs : array<string|int, mixed>: Shown IDs
$_subgroups : array<string|int, mixed>: Array of subgroups
$_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

Methods

__construct() : mixed: Constructor.
addAllGroups() : self: Adding all groups for showing
addAllowedProperties() : self: Add additional allowed properties
addAllowedProperty() : self: Add additional allowed property
addAllowedTag() : self: Add tag to allowed tags list
addAllowedTags() : self: Add tags to allowed tags list
addCacheSignature() : self: Add additional signature for cache name
addCacheTag() : self: Add Cache Tag
addEntities() : self: Add enities
addEntity() : self: Add a children entity
addFilter() : mixed: Add filter condition ->addFilter('property', 17, '=', 33)
addForbiddenTag() : self: Add tag to forbidden tags list
addForbiddenTags() : self: Add tags to forbidden tags list
addTreeGroups() : self: Add groups tree
append() : self: Append an element to an assigned array
applyFilter() : self: Apply Filter
applyFilterGroupCondition() : self: Apply Condition By Group, depends on $this->group, $this->subgroups
applyForbiddenAllowedTags() : self: Apply Forbidden-Allowed Tags for Entity
applyGroupCondition() : self: Apply item's condition by informationsystem_group_id
applyGroupsForbiddenTags() : self: Apply forbidden tags
applyItemsForbiddenTags() : self: Apply forbidden XML tags for items
assign() : self: Assign variables/objects to the TPL-template
clearCacheTag() : self: Clear Cache Tag
clearEntities() : self: Clear enities
clearVars() : self: Clear vars
error403() : self: Define handler for 403 error
error404() : self: Define handler for 404 error
fillInformationsystemGroups() : mixed
forbidSelectShortcuts() : self: Disable shortcuts
get() : string: Get HTML based by entities tree, use XSL $this->_xsl
getAllowedTags() : array<string|int, mixed>: Get allowed tags list
getCacheTags() : array<string|int, mixed>: Get Cache Tags
getCommentProperties() : array<string|int, mixed>: Get _aComment_Properties set
getCommentPropertyDirs() : array<string|int, mixed>: Get _aItem_Property_Dirs set
getData() : array<string|int, mixed>: Prepare date
getEntities() : array<string|int, mixed>: Get enities
getEntity() : object: Get entity
getFilterProperties() : array<string|int, mixed>: Get Filter Properties
getForbiddenTags() : array<string|int, mixed>: Get forbidden tags list
getGroupProperties() : array<string|int, mixed>: Get _aGroup_Properties set
getGroupPropertyDirs() : array<string|int, mixed>: Get _aGroup_Property_Dirs set
getInformationsystemGroups() : array<string|int, mixed>: Get _aInformationsystem_Groups set
getInformationsystemItems() : array<string|int, mixed>: Get Shop_Items
getItemProperties() : array<string|int, mixed>: Get _aItem_Properties set
getItemPropertyDirs() : array<string|int, mixed>: Get _aItem_Property_Dirs set
getJson() : string: Get JSON
getPattern() : string: Get Pattern
getSeoGroupH1() : string|null: Get SEO Group's H1
getSeoItemH1() : string|null: Get SEO Items's H1
getShownIDs() : array<string|int, mixed>: Get shown IDs
getStdObject() : array<string|int, mixed>: Get ARRAY for entity and children entities
getSubgroups() : array<string|int, mixed>: Get array of subgroups ID, inc. $group_id
getTpl() : Tpl_Model: Get TPL
getXml() : string: Get XML for entity and children entities
getXsl() : Xsl_Model: Get XSL
inCache() : null|true|false: Check if data is cached
informationsystemGroups() : self: Get/set _Informationsystem_Groups
informationsystemItems() : self: Get/set _Informationsystem_Items
isAllowedTag() : bool: Check if a tag is allowed
isForbiddenTag() : bool: Check if a tag is forbidden
mode() : self: Set mode
orderBy() : self: Set items sorting
pageNumber() : string: Get page number with template $template
parseUrl() : informationsystem_Controller_Show: Parse URL and set controller properties
removeAllowedTag() : self: Remove tag from allowed tags list
removeFilter() : mixed: Remove filter condition ->removeFilter('property', 17)
removeForbiddenTag() : self: Remove tag from forbidden tags list
seoFilter() : string: Get properties for seo fields
set() : self: Run when writing data to inaccessible properties
setAttributePrefix() : self: Change attributePrefix
setEntity() : self: Set entity
setFilterProperties() : self: Set Filter Properties
setUnlimitedProperties() : self: Set unlimitedProperties
show() : self: Show built data
tpl() : self: Set TPL
xsl() : self: Set XSL
_addCommentsPropertiesList() : self: Add items properties list to $parentObject
_addFilterPropertyToXml() : self: Add Filter Property to the XML
_addGroupsByParentId() : self: Add groups to the object by parent ID
_addGroupsPropertiesList() : self: Add groups properties list to $parentObject
_addItemsPropertiesList() : self: Add items properties list to $parentObject
_applyItemConditions() : self: Apply item's conditions
_basicFilter() : self: Apply Basic Filter
_convertReceivedPropertyValue() : string: Convert property value, e.g. '23.11.2020' => '2020-11-23 00:00:00'
_getGroupData() : array<string|int, mixed>: Typical conversion of Shop_Groups to an array
_getItemData() : array<string|int, mixed>: Typical conversion of Shop_Items to an array
_getListItemData() : array<string|int, mixed>: Typical conversion of List_Item to an array
_getPropertyData() : array<string|int, mixed>: Typical conversion of Property to an array
_getSiteuserGroups() : array<string|int, mixed>: Get array of siteuser groups for current siteuser. Exists group 0 (all) and -1 (parent)
_groupCondition() : self: Set item's condition by informationsystem_group_id
_groupIntoArray() : self: Add group $oInformationsystem_Group into $this->_aInformationsystem_Groups
_incShowed() : self: Inc Informationsystem_Item->showed
_itemCondition() : self: Set item's conditions
_itemsProperties() : mixed: Add list of item properties
_setGroupsActivity() : self: Set groups activity
_setInformationsystemGroups() : self: Prepare groups for showing
_setInformationsystemItems() : self: Prepare items for showing
_setItemsActivity() : self: Set items activity
_setLimits() : self: Set offset and limit
_showPanel() : self: Show frontend panel

$_aComment_Properties

List of properties for item


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

$_aComment_Property_Dirs

List of property directories for item


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

$_aFilterProperties

Array of Properties conditions, see addFilter()


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

$_aGroup_Properties

List of properties for group


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

$_aGroup_Property_Dirs

List of property directories for group


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

$_aGroupTree

Groups Tree For fillInformationsystemGroups()


    protected
        null|array<string|int, mixed>
    $_aGroupTree
     = \NULL

$_aInformationsystem_Groups

List of groups of information systems


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

$_aItem_Properties

List of properties for item


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

$_aItem_Property_Dirs

List of property directories for item


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

$_allowedProperties

Allowed object properties


    protected
        array<string|int, mixed>
    $_allowedProperties
     = array('group', 'subgroups', 'groupsProperties', 'groupsPropertiesList', 'propertiesForGroups', 'groupsMode', 'groupsForbiddenTags', 'item', 'itemsProperties', 'itemsPropertiesList', 'sortPropertiesValues', 'commentsProperties', 'commentsPropertiesList', 'groupsMedia', 'itemsMedia', 'itemsForbiddenTags', 'comments', 'commentsRating', 'votes', 'tags', 'calculateCounts', 'siteuser', 'siteuserProperties', 'offset', 'limit', 'page', 'part', 'parts', 'total', 'pattern', 'patternExpressions', 'patternParams', 'patternPart', 'patternTag', 'tag', 'cache', 'itemsActivity', 'groupsActivity', 'commentsActivity', 'calculateTotal', 'showPanel', 'url', 'getItemDataCallback', 'getGroupDataCallback')

$_allowedTags

Allowed tags for specified elements


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

$_aSiteuserGroups

Array of siteuser's groups allowed for current siteuser


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

$_attributePrefix

Attribute's prefix


    protected
        string
    $_attributePrefix
     = '_'

$_cacheApplyForbiddenAllowedTags

Cache for applyForbiddenAllowedTags


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

$_cacheName

Cache name


    protected
        string
    $_cacheName
     = 'informationsystem_show'

$_cacheTags

Cache tags


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

$_entities

List of children entities


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

$_entity

Entity


    protected
        Core_Entity
    $_entity
     = \NULL

$_errorCode

Error code


    protected
        int|null
    $_errorCode
     = \NULL

$_forbiddenTags

Forbidden tags for specified elements


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

$_Informationsystem_Groups

Information system's group object


    protected
        Informationsystem_Group_Model
    $_Informationsystem_Groups
     = \NULL

$_Informationsystem_Items

Information system's items object


    protected
        Informationsystem_Item_Model
    $_Informationsystem_Items
     = \NULL

$_mode

Controller's mode


    protected
        string
    $_mode
     = 'json'

$_oTag

Current Tag


    protected
        null|Tag_Model
    $_oTag
     = \NULL

$_propertiesValues

Properties values


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

$_seoGroupDescription


    protected
        mixed
    $_seoGroupDescription
     = \NULL

$_seoGroupH1


    protected
        mixed
    $_seoGroupH1
     = \NULL

$_seoGroupKeywords


    protected
        mixed
    $_seoGroupKeywords
     = \NULL

$_seoGroupTitle


    protected
        mixed
    $_seoGroupTitle
     = \NULL

$_seoItemDescription


    protected
        mixed
    $_seoItemDescription
     = \NULL

$_seoItemH1


    protected
        mixed
    $_seoItemH1
     = \NULL

$_seoItemKeywords


    protected
        mixed
    $_seoItemKeywords
     = \NULL

$_seoItemTitle


    protected
        mixed
    $_seoItemTitle
     = \NULL

$_shownIDs

Shown IDs


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

$_subgroups

Array of subgroups


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

$_tpl

TPL


    protected
        Tpl_Model
    $_tpl
     = \NULL

$_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()

$_xsl

XSL


    protected
        Xsl_Model
    $_xsl
     = \NULL

__construct()

Constructor.


    public
                    __construct(Informationsystem_Model $oInformationsystem) : mixed

Parameters

$oInformationsystem : Informationsystem_Model: information system

addAllGroups()

Adding all groups for showing


    public
                    addAllGroups() : self

Return values

self

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

addAllowedTag()

Add tag to allowed tags list


    public
                    addAllowedTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self

addAllowedTags()

Add tags to allowed tags list


    public
                    addAllowedTags(string $path[, array<string|int, mixed> $aTags = array() ]) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$aTags : array<string|int, mixed> = array(): array of tags

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

addEntity()

Add a children entity


    public
                    addEntity(Core_Entity $oChildrenEntity) : self

Parameters

$oChildrenEntity : Core_Entity

Return values

self

addFilter()

Add filter condition ->addFilter('property', 17, '=', 33)


    public
                    addFilter() : mixed

addForbiddenTag()

Add tag to forbidden tags list


    public
                    addForbiddenTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self

addForbiddenTags()

Add tags to forbidden tags list


    public
                    addForbiddenTags(string $path[, array<string|int, mixed> $aTags = array() ]) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$aTags : array<string|int, mixed> = array(): array of tags

Return values

self

addTreeGroups()

Add groups tree


    public
                    addTreeGroups() : self

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

applyFilter()

Apply Filter


    public
                    applyFilter() : self

Return values

self

applyFilterGroupCondition()

Apply Condition By Group, depends on $this->group, $this->subgroups


    public
                    applyFilterGroupCondition(Core_QueryBuilder_Select $oQueryBuilder, string $fieldName) : self

Parameters

$oQueryBuilder : Core_QueryBuilder_Select
$fieldName : string

Return values

self

applyForbiddenAllowedTags()

Apply Forbidden-Allowed Tags for Entity


    public
                    applyForbiddenAllowedTags(string $path, Core_Entity|array<string|int, mixed> $mEntity) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$mEntity : Core_Entity|array<string|int, mixed>

Return values

self

applyGroupCondition()

Apply item's condition by informationsystem_group_id


    public
                    applyGroupCondition() : self

Return values

self

applyGroupsForbiddenTags()

Apply forbidden tags


    public
                    applyGroupsForbiddenTags(Informationsystem_Group $oInformationsystem_Group) : self

Parameters

$oInformationsystem_Group : Informationsystem_Group

Return values

self

applyItemsForbiddenTags()

Apply forbidden XML tags for items


    public
                    applyItemsForbiddenTags(Informationsystem_Item_Model $oInformationsystem_Item) : self

Parameters

$oInformationsystem_Item : Informationsystem_Item_Model: item

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

error403()

Define handler for 403 error


    public
                    error403() : self

Return values

self

error404()

Define handler for 404 error


    public
                    error404() : self

Return values

self

fillInformationsystemGroups()


    public
                    fillInformationsystemGroups([mixed $parent_id = 0 ]) : mixed

Parameters

$parent_id : mixed = 0

forbidSelectShortcuts()

Disable shortcuts


    public
                    forbidSelectShortcuts() : self

Return values

self

get()

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


    public
                    get() : string

Return values

string

getAllowedTags()

Get allowed tags list


    public
                    getAllowedTags() : 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>

getCommentProperties()

Get _aComment_Properties set


    public
                    getCommentProperties() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCommentPropertyDirs()

Get _aItem_Property_Dirs set


    public
                    getCommentPropertyDirs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getData()

Prepare date


    public
                    getData() : 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

getFilterProperties()

Get Filter Properties


    public
                    getFilterProperties() : array<string|int, mixed>

Return values

array<string|int, mixed>

getForbiddenTags()

Get forbidden tags list


    public
                    getForbiddenTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getGroupProperties()

Get _aGroup_Properties set


    public
                    getGroupProperties() : array<string|int, mixed>

Return values

array<string|int, mixed>

getGroupPropertyDirs()

Get _aGroup_Property_Dirs set


    public
                    getGroupPropertyDirs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getInformationsystemGroups()

Get _aInformationsystem_Groups set


    public
                    getInformationsystemGroups() : array<string|int, mixed>

Return values

array<string|int, mixed>

getInformationsystemItems()

Get Shop_Items


    public
                    getInformationsystemItems() : array<string|int, mixed>

Return values

array<string|int, mixed>

getItemProperties()

Get _aItem_Properties set


    public
                    getItemProperties() : array<string|int, mixed>

Return values

array<string|int, mixed>

getItemPropertyDirs()

Get _aItem_Property_Dirs set


    public
                    getItemPropertyDirs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getJson()

Get JSON


    public
                    getJson() : string

Return values

string

getPattern()

Get Pattern


    public
                    getPattern() : string

Return values

string

getSeoGroupH1()

Get SEO Group's H1


    public
                    getSeoGroupH1() : string|null

Return values

string|null

getSeoItemH1()

Get SEO Items's H1


    public
                    getSeoItemH1() : string|null

Return values

string|null

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>

getSubgroups()

Get array of subgroups ID, inc. $group_id


    public
                    getSubgroups(int $group_id) : array<string|int, mixed>

Parameters

$group_id : int

Return values

array<string|int, mixed>

getTpl()

Get TPL


    public
                    getTpl() : Tpl_Model

Return values

Tpl_Model

getXml()

Get XML for entity and children entities


    public
                    getXml() : string

Return values

string

getXsl()

Get XSL


    public
                    getXsl() : Xsl_Model

Return values

Xsl_Model

inCache()

Check if data is cached


    public
                    inCache() : null|true|false

Return values

null|true|false

informationsystemGroups()

Get/set _Informationsystem_Groups


    public
                    informationsystemGroups([mixed $object = NULL ]) : self

Parameters

$object : mixed = NULL

Return values

self —

or _Informationsystem_Groups

informationsystemItems()

Get/set _Informationsystem_Items


    public
                    informationsystemItems([mixed $object = NULL ]) : self

Parameters

$object : mixed = NULL

Return values

self —

or _Informationsystem_Items

isAllowedTag()

Check if a tag is allowed


    public
                    isAllowedTag(string $path, string $tag) : bool

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

bool

isForbiddenTag()

Check if a tag is forbidden


    public
                    isForbiddenTag(string $path, string $tag) : bool

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

bool

mode()

Set mode


    public
                    mode(string $mode) : self

Parameters

$mode : string

Return values

self

orderBy()

Set items sorting


    public
                    orderBy( $column[, mixed $direction = 'ASC' ]) : self

Parameters

$column :: Column name
$direction : mixed = 'ASC'

Return values

self

pageNumber()

Get page number with template $template


    public
                    pageNumber([ $template = "%d" ]) : string

Parameters

$template : = "%d": template, e.g. ", page %d"

Return values

string

parseUrl()

Parse URL and set controller properties


    public
                    parseUrl() : informationsystem_Controller_Show

Return values

informationsystem_Controller_Show

removeAllowedTag()

Remove tag from allowed tags list


    public
                    removeAllowedTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self

removeFilter()

Remove filter condition ->removeFilter('property', 17)


    public
                    removeFilter() : mixed

removeForbiddenTag()

Remove tag from forbidden tags list


    public
                    removeForbiddenTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self

seoFilter()

Get properties for seo fields


    public
                    seoFilter([ $nameSeparator = ": " ][,  $valueSeparator = ", " ]) : string

Parameters

$nameSeparator : = ": ": property name separator
$valueSeparator : = ", ": property value separator

Return values

string

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

setEntity()

Set entity


    public
                    setEntity(Core_Entity $entity) : self

Parameters

$entity : Core_Entity: entity

Return values

self

setFilterProperties()

Set Filter Properties


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

Parameters

$array : array<string|int, mixed>

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

Return values

self

tpl()

Set TPL


    public
                    tpl(Tpl_Model|string $tpl) : self

Parameters

$tpl : Tpl_Model|string

Return values

self

xsl()

Set XSL


    public
                    xsl(Xsl_Model|string $xsl) : self

Parameters

$xsl : Xsl_Model|string

Return values

self

_addCommentsPropertiesList()

Add items properties list to $parentObject


    protected
                    _addCommentsPropertiesList(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int: parent group ID
$parentObject : object: object

Return values

self

_addFilterPropertyToXml()

Add Filter Property to the XML


    protected
                    _addFilterPropertyToXml(Property_Model $oProperty, string $condition, array<string|int, mixed> $aPropertyValues) : self

Parameters

$oProperty : Property_Model
$condition : string
$aPropertyValues : array<string|int, mixed>

Return values

self

_addGroupsByParentId()

Add groups to the object by parent ID


    protected
                    _addGroupsByParentId(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int: parent group ID
$parentObject : object: object

Return values

self

_addGroupsPropertiesList()

Add groups properties list to $parentObject


    protected
                    _addGroupsPropertiesList(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int: parent group ID
$parentObject : object: object

Return values

self

_addItemsPropertiesList()

Add items properties list to $parentObject


    protected
                    _addItemsPropertiesList(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int: parent group ID
$parentObject : object: object

Return values

self

_applyItemConditions()

Apply item's conditions


    protected
                    _applyItemConditions(Informationsystem_Item_Model $oInformationsystem_Items) : self

Parameters

$oInformationsystem_Items : Informationsystem_Item_Model

Return values

self

_basicFilter()

Apply Basic Filter


    protected
                    _basicFilter() : self

Return values

self

_convertReceivedPropertyValue()

Convert property value, e.g. '23.11.2020' => '2020-11-23 00:00:00'


    protected
                    _convertReceivedPropertyValue(Property_Model $oProperty, mixed $value) : string

Parameters

$oProperty : Property_Model
$value : mixed

Return values

string

_getGroupData()

Typical conversion of Shop_Groups to an array


    protected
                    _getGroupData(array<string|int, mixed> $aShop_Grpoups) : array<string|int, mixed>

Parameters

$aShop_Grpoups : array<string|int, mixed>

Return values

array<string|int, mixed>

_getItemData()

Typical conversion of Shop_Items to an array


    protected
                    _getItemData(array<string|int, mixed> $aShop_Items) : array<string|int, mixed>

Parameters

$aShop_Items : array<string|int, mixed>

Return values

array<string|int, mixed>

_getListItemData()

Typical conversion of List_Item to an array


    protected
                    _getListItemData(array<string|int, mixed> $aList_Items) : array<string|int, mixed>

Parameters

$aList_Items : array<string|int, mixed>

Return values

array<string|int, mixed>

_getPropertyData()

Typical conversion of Property to an array


    protected
                    _getPropertyData(array<string|int, mixed> $aProperties) : array<string|int, mixed>

Parameters

$aProperties : array<string|int, mixed>

Return values

array<string|int, mixed>

_getSiteuserGroups()

Get array of siteuser groups for current siteuser. Exists group 0 (all) and -1 (parent)


    protected
                    _getSiteuserGroups() : array<string|int, mixed>

Return values

array<string|int, mixed>

_groupCondition()

Set item's condition by informationsystem_group_id


    protected
                    _groupCondition() : self

Return values

self

_groupIntoArray()

Add group $oInformationsystem_Group into $this->_aInformationsystem_Groups


    protected
                    _groupIntoArray(Informationsystem_Group_Model $oInformationsystem_Group) : self

Parameters

$oInformationsystem_Group : Informationsystem_Group_Model

Return values

self

_incShowed()

Inc Informationsystem_Item->showed


    protected
                    _incShowed() : self

Return values

self

_itemCondition()

Set item's conditions


    protected
                    _itemCondition() : self

Return values

self

_itemsProperties()

Add list of item properties


    protected
                    _itemsProperties() : mixed

_setGroupsActivity()

Set groups activity


    protected
                    _setGroupsActivity() : self

Return values

self

_setInformationsystemGroups()

Prepare groups for showing


    protected
                    _setInformationsystemGroups() : self

Return values

self

_setInformationsystemItems()

Prepare items for showing


    protected
                    _setInformationsystemItems() : self

Return values

self

_setItemsActivity()

Set items activity


    protected
                    _setItemsActivity() : self

Return values

self

_setLimits()

Set offset and limit


    protected
                    _setLimits() : self

Return values

self

_showPanel()

Show frontend panel


    protected
                    _showPanel() : self

Return values

self

Informationsystem_Controller_Show extends Core_Controller in package HostCMS Informationsystem

Tags

Table of Contents

Properties

Methods

Properties

$_aComment_Properties

$_aComment_Property_Dirs

$_aFilterProperties

$_aGroup_Properties

$_aGroup_Property_Dirs

$_aGroupTree

$_aInformationsystem_Groups

$_aItem_Properties

$_aItem_Property_Dirs

$_allowedProperties

$_allowedTags

$_aSiteuserGroups

$_attributePrefix

$_cacheApplyForbiddenAllowedTags

$_cacheName

$_cacheTags

$_entities

$_entity

$_errorCode

$_forbiddenTags

$_Informationsystem_Groups

$_Informationsystem_Items

$_mode

$_oTag

$_propertiesValues

$_seoGroupDescription

$_seoGroupH1

$_seoGroupKeywords

$_seoGroupTitle

$_seoItemDescription

$_seoItemH1

$_seoItemKeywords

$_seoItemTitle

$_shownIDs

$_subgroups

$_tpl

$_unlimitedProperties

$_vars

$_xsl

Methods

__construct()

Parameters

addAllGroups()

Return values

addAllowedProperties()

Parameters

Return values

addAllowedProperty()

Parameters

Return values

addAllowedTag()

Parameters

Return values

addAllowedTags()

Parameters

Return values

addCacheSignature()

Parameters

Return values

addCacheTag()

Parameters

Return values

addEntities()

Parameters

Return values

addEntity()

Parameters

Return values

addFilter()

addForbiddenTag()

Parameters

Return values

addForbiddenTags()

Parameters

Informationsystem_Controller_Show extends Core_Controller
in package

HostCMS

Informationsystem