Documentation

Informationsystem_Comment_Controller_Show extends Core_Controller

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

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

  • commentsActivity('active'|'inactive'|'all') отображать комментарии: active - только активные, inactive - только неактивные, all - все, по умолчанию - active
  • offset($offset) смещение, с которого выводить комментарии. По умолчанию 0
  • limit($limit) количество выводимых комментариев
  • page(2) текущая страница, по умолчанию 0, счет ведется с 0
  • pattern($pattern) шаблон разбора данных в URI, см. __construct()
  • cache(TRUE|FALSE) использовать кэширование, по умолчанию TRUE
  • calculateTotal(TRUE|FALSE) вычислять общее количество найденных, по умолчанию TRUE
  • commentsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств комментариев, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
  • commentsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств комментариев, по умолчанию TRUE.
  • addAllowedTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, разрешенных к передаче в генерируемый XML
  • addForbiddenTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, запрещенных к передаче в генерируемый XML

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

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

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

  • commentsForbiddenTags(array('email')) массив тегов комментария, запрещенных к передаче в генерируемый XML

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

  • '/' или '/informationsystem' Информационная система
  • '/informationsystem/comment' Комментарии
  • '/informationsystem/informationsystem_item' Информационный элемент
$Informationsystem_Comment_Controller_Show = new Informationsystem_Comment_Controller_Show( Core_Entity::factory('Informationsystem', 1) );

$Informationsystem_Comment_Controller_Show ->xsl('СписокКомментариевНаГлавной') ->commentsProperties(TRUE) ->limit(5) ->show();

Tags
subpackage

Informationsystem

version
7.x
author

Hostmake LLC

copyright

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

Table of Contents

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
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_allowedTags  : array<string|int, mixed>
Allowed tags for specified elements
$_attributePrefix  : string
Attribute's prefix
$_cacheApplyForbiddenAllowedTags  : array<string|int, mixed>
Cache for applyForbiddenAllowedTags
$_cacheName  : string
Cache name
$_cacheTags  : array<string|int, mixed>
Cache tags
$_Comments  : mixed
Comments QB
$_entities  : array<string|int, mixed>
List of children entities
$_entity  : Core_Entity
Entity
$_forbiddenTags  : array<string|int, mixed>
Forbidden tags for specified elements
$_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

Methods

__construct()  : mixed
Constructor.
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
addForbiddenTag()  : self
Add tag to forbidden tags list
addForbiddenTags()  : self
Add tags to forbidden tags list
append()  : self
Append an element to an assigned array
applyForbiddenAllowedTags()  : self
Apply Forbidden-Allowed Tags for Entity
applyforbiddenTags()  : self
Apply forbidden XML tags for comments
assign()  : self
Assign variables/objects to the TPL-template
clearCacheTag()  : self
Clear Cache Tag
clearEntities()  : self
Clear enities
clearVars()  : self
Clear vars
comments()  : Informationsystem_Item_Model
Get items
error403()  : self
Define handler for 403 error
error404()  : self
Define handler for 404 error
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
getEntities()  : array<string|int, mixed>
Get enities
getEntity()  : object
Get entity
getForbiddenTags()  : array<string|int, mixed>
Get forbidden tags list
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
inCache()  : null|true|false
Check if data is cached
isAllowedTag()  : bool
Check if a tag is allowed
isForbiddenTag()  : bool
Check if a tag is forbidden
mode()  : self
Set mode
parseUrl()  : Informationsystem_Comment_Controller_Show
Parse URL and set controller properties
removeAllowedTag()  : self
Remove tag from allowed tags list
removeForbiddenTag()  : self
Remove tag from forbidden tags list
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
_addCommentsPropertiesList()  : self
Add items properties list to $parentObject
_setComments()  : self
Prepare groups for showing
_setLimits()  : self
Set offset and limit

Properties

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

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('offset', 'limit', 'page', 'total', 'pattern', 'patternExpressions', 'patternParams', 'cache', 'commentsForbiddenTags', 'commentsActivity', 'calculateTotal', 'commentsProperties', 'commentsPropertiesList', 'url')

$_allowedTags

Allowed tags for specified elements

protected array<string|int, mixed> $_allowedTags = 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_comment_show'

$_cacheTags

Cache tags

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

$_Comments

Comments QB

protected mixed $_Comments = \NULL

$_entities

List of children entities

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

$_forbiddenTags

Forbidden tags for specified elements

protected array<string|int, mixed> $_forbiddenTags = 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

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

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

append()

Append an element to an assigned array

public append(mixed $varname, mixed $var) : self
Parameters
$varname : mixed
$var : mixed
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

applyforbiddenTags()

Apply forbidden XML tags for comments

public applyforbiddenTags(Comment_Model $oComment) : self
Parameters
$oComment : Comment_Model
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

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

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>

getEntities()

Get enities

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

getEntity()

Get entity

public getEntity() : object
Return values
object

getForbiddenTags()

Get forbidden tags list

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

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

inCache()

Check if data is cached

public inCache() : null|true|false
Return values
null|true|false

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

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

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

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

Informationsystem_Comment_Controller_Show.onBeforeRedeclaredShow

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

_setComments()

Prepare groups for showing

protected _setComments() : self
Return values
self

_setLimits()

Set offset and limit

protected _setLimits() : self
Return values
self

        
On this page

Search results