Documentation

Informationsystem_Controller_Rss_Show extends Core_Controller

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

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

  • channelEntities(array) массив дополнительных элементов, добавляемых в channel, каждый элемент массив с атрибутами 'name', 'value', 'attributes'
  • itemProperties(array) массив соответствия для вывода дополнительных свойств в тегах элементов, например, array(3 => 'enclosure', 7 => 'category')
  • group($id) идентификатор информационной группы, если FALSE, то вывод инофрмационных элементов осуществляется из всех групп
  • yandex(TRUE|FALSE) экспорт в Яндекс.Новости, по умолчанию FALSE
  • turbo(TRUE|FALSE) выгрузка для Яндекс.Турбо, по умолчанию FALSE
  • 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();
Tags
subpackage

Informationsystem

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
$_attributePrefix  : string
Attribute's prefix
$_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
$_Informationsystem_Items  : array<string|int, mixed>
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
__construct()  : mixed
Constructor.
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
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
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
get()  : string
Get HTML based by entities tree, use XSL $this->_xsl
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
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()  : array<string|int, mixed>
Get information items
mode()  : self
Set mode
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

Properties

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

$_attributePrefix

Attribute's prefix

protected string $_attributePrefix = '_'

$_cacheTags

Cache tags

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

$_currentItem

Current <item>

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

$_entities

List of children entities

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

$_Informationsystem_Items

Information system's items object

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

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

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

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

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

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

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

informationsystemItems()

Get information items

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

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

setCurrentItem()

Set $this->_currentItem

public setCurrentItem(array<string|int, mixed> $aItem) : self
Parameters
$aItem : 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 RSS

public show() : self
Tags
hostcms-event

Informationsystem_Controller_Rss_Show.onBeforeRedeclaredShow

hostcms-event

Informationsystem_Controller_Rss_Show.onBeforeAddItem

Return values
self

Search results