Documentation

Informationsystem_Controller_Rss_Show extends Core_Controller
in package

HostCMS

Informationsystem

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

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

channelEntities(array) массив дополнительных элементов, добавляемых в channel, каждый элемент массив с атрибутами 'name', 'value', 'attributes'
itemProperties(array) массив соответствия для вывода дополнительных свойств в тегах элементов, например, array(3 => 'enclosure', 7 => 'category')
group($id) идентификатор информационной группы, если FALSE, то вывод инофрмационных элементов осуществляется из всех групп
yandex(TRUE|FALSE) экспорт в Яндекс.Новости, по умолчанию FALSE
turbo(TRUE|FALSE|'disable') выгрузка для Яндекс.Турбо, по умолчанию FALSE, при 'disable' формируется список на удаление со ссылкой на страницу
stripTags(TRUE|FALSE) удалять HTML-теги из экспортируемых данных, по умолчанию TRUE
cache(TRUE|FALSE) использовать кэширование, по умолчанию TRUE
tag($path) путь тега, с использованием которого ведется отбор информационных элементов
offset($offset) смещение, с которого выводить информационные элементы. По умолчанию 0
limit($limit) количество выводимых элементов


$Informationsystem_Controller_Rss_Show = new Informationsystem_Controller_Rss_Show(
		Core_Entity::factory('Informationsystem', 1)
	);
$Informationsystem_Controller_Rss_Show
	->limit(10)
	->show();

Properties

$_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
$_cacheTags : array<string|int, mixed>: Cache tags
$_Core_Rss : Core_Rss: RSS
$_currentItem : array<string|int, mixed>: Current <item>
$_entities : array<string|int, mixed>: List of children entities
$_entity : Core_Entity: Entity
$_forbiddenTags : array<string|int, mixed>: Forbidden tags for specified elements
$_Informationsystem_Items : Informationsystem_Item_Model: Information system's items object
$_mode : string: Controller's mode
$_path : string: Path
$_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
assign() : self: Assign variables/objects to the TPL-template
clearCacheTag() : self: Clear Cache Tag
clearEntities() : self: Clear enities
clearVars() : self: Clear vars
coreRss() : Core_Rss: Get RSS
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
getCurrentItem() : array<string|int, mixed>: Get $this->_currentItem
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
informationsystemItems() : object: Get information items
isAllowedTag() : bool: Check if a tag is allowed
isForbiddenTag() : bool: Check if a tag is forbidden
mode() : self: Set mode
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
setCurrentItem() : self: Set $this->_currentItem
setEntity() : self: Set entity
setUnlimitedProperties() : self: Set unlimitedProperties
show() : self: Show RSS
tpl() : self: Set TPL
xsl() : self: Set XSL
_setInformationsystemItems() : self: Prepare items for showing

$_allowedProperties

Allowed object properties


    protected
        array<string|int, mixed>
    $_allowedProperties
     = array('title', 'description', 'link', 'image', 'channelEntities', 'itemProperties', 'group', 'tag', 'offset', 'limit', 'yandex', 'turbo', 'stripTags', 'cache')

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

$_cacheTags

Cache tags


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

$_Core_Rss

RSS


    protected
        Core_Rss
    $_Core_Rss
     = array()

$_currentItem

Current <item>


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

$_entities

List of children entities


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

$_entity

Entity


    protected
        Core_Entity
    $_entity
     = \NULL

$_forbiddenTags

Forbidden tags for specified elements


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

$_Informationsystem_Items

Information system's items object


    protected
        Informationsystem_Item_Model
    $_Informationsystem_Items
     = \NULL

$_mode

Controller's mode


    protected
        string
    $_mode
     = 'json'

$_path

Path


    protected
        string
    $_path
     = \NULL

$_propertiesValues

Properties values


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

$_shownIDs

Shown IDs


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

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

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

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

coreRss()

Get RSS


    public
                    coreRss() : Core_Rss

Return values

Core_Rss

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>

getCurrentItem()

Get $this->_currentItem


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

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

informationsystemItems()

Get information items


    public
                    informationsystemItems() : object

Return values

object

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

setCurrentItem()

Set $this->_currentItem


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

Parameters

$aItem : array<string|int, mixed>

Return values

self

setEntity()

Set entity


    public
                    setEntity(Core_Entity $entity) : self

Parameters

$entity : Core_Entity: entity

Return values

self

setUnlimitedProperties()

Set unlimitedProperties


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

Parameters

$value : bool = TRUE: default TRUR

Return values

self

show()

Show RSS


    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

_setInformationsystemItems()

Prepare items for showing


    protected
                    _setInformationsystemItems() : self

Return values

self

Informationsystem_Controller_Rss_Show extends Core_Controller in package HostCMS Informationsystem

Tags

Table of Contents

Properties

Methods

Properties

$_allowedProperties

$_allowedTags

$_attributePrefix

$_cacheApplyForbiddenAllowedTags

$_cacheTags

$_Core_Rss

$_currentItem

$_entities

$_entity

$_forbiddenTags

$_Informationsystem_Items

$_mode

$_path

$_propertiesValues

$_shownIDs

$_tpl

$_unlimitedProperties

$_vars

$_xsl

Methods

__construct()

Parameters

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

addForbiddenTag()

Parameters

Return values

addForbiddenTags()

Parameters

Return values

append()

Parameters

Return values

applyForbiddenAllowedTags()

Parameters

Return values

assign()

Parameters

Return values

clearCacheTag()

Return values

clearEntities()

Return values

clearVars()

Return values

coreRss()

Return values

forbidSelectShortcuts()

Return values

get()

Tags

Return values

Informationsystem_Controller_Rss_Show extends Core_Controller
in package

HostCMS

Informationsystem