Documentation

Deal_Controller_Show extends Core_Controller
in package

HostCMS

Deal

Показ сделок.

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

itemsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств сделок, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
sortPropertiesValues(TRUE|FALSE) сортировать значения дополнительных свойств, по умолчанию TRUE.
dealsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств заказов, по умолчанию FALSE. Работает только при dealTemplates(TRUE)
showDeals(TRUE|FALSE) выводить список сделок, по умолчанию TRUE
shops(TRUE|FALSE) выводить список магазинов, по умолчанию FALSE
dealTemplates(TRUE|FALSE) выводить список типов сделок, по умолчанию FALSE
dealTemplateSteps(TRUE|FALSE) выводить список этапов типа сделки, по умолчанию FALSE. Работает только при dealTemplates(TRUE)
attachments(TRUE|FALSE) выводить список файлов сделки, по умолчанию FALSE
notes(TRUE|FALSE) выводить заметки сделки, по умолчанию FALSE
shopItems(TRUE|FALSE) выводить товары сделки, по умолчанию FALSE
dealSiteusers(TRUE|FALSE) выводить клиентов сделки, по умолчанию FALSE
events(TRUE|FALSE) выводить дела сделки, по умолчанию FALSE
offset($offset) смещение, с которого выводить сделки. По умолчанию 0
limit($limit) количество выводимых сделок
page(2) текущая страница, по умолчанию 0, счет ведется с 0
pattern($pattern) шаблон разбора данных в URI, см. __construct()
addAllowedTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, разрешенных к передаче в генерируемый XML
addForbiddenTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, запрещенных к передаче в генерируемый XML

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

'/' или '/site' Сайт
'/site/deal' Сделка
'/site/shops/shop' Магазин
'/site/deal_templates/deal_template' Шаблон сделки
'/site/deal_template_steps/deal_template_step' Шаги шаблона сделки
'/site/deal_properties/property' Свойство в списке свойств сделки
'/site/deal_properties/property_dir' Раздел свойств в списке свойств сделки

Properties

$_aDeal_Properties : array<string|int, mixed>: List of properties for deal
$_aDeal_Property_Dirs : array<string|int, mixed>: List of property directories for deal
$_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
$_Deals : Deals: Deals
$_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
assign() : self: Assign variables/objects to the TPL-template
clearCacheTag() : self: Clear Cache Tag
clearEntities() : self: Clear enities
clearVars() : self: Clear vars
deals() : Deal_Model: Get deals
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
getDealProperties() : array<string|int, mixed>: Get _aDeal_Properties
getDealPropertyDirs() : array<string|int, mixed>: Get _aDeal_Property_Dirs
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
isAllowedTag() : bool: Check if a tag is allowed
isForbiddenTag() : bool: Check if a tag is forbidden
mode() : self: Set mode
parseUrl() : self: 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
_addDealsPropertiesList() : self: Add items properties list to $parentObject

$_aDeal_Properties

List of properties for deal


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

$_aDeal_Property_Dirs

List of property directories for deal


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

$_allowedProperties

Allowed object properties


    protected
        array<string|int, mixed>
    $_allowedProperties
     = array('itemsProperties', 'sortPropertiesValues', 'dealsPropertiesList', 'showDeals', 'shops', 'dealTemplates', 'dealTemplateSteps', 'attachments', 'notes', 'shopItems', 'dealSiteusers', 'events', 'offset', 'limit', 'page', 'total', 'deal_template_id', 'pattern', 'patternExpressions', 'patternParams', '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()

$_cacheTags

Cache tags


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

$_Deals

Deals


    protected
        Deals
    $_Deals
     = \NULL

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

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

$_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(Site_Model $oSite) : mixed

Parameters

$oSite : Site_Model: site

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

deals()

Get deals


    public
                    deals() : Deal_Model

Return values

Deal_Model

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

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>

getDealProperties()

Get _aDeal_Properties


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

Return values

array<string|int, mixed>

getDealPropertyDirs()

Get _aDeal_Property_Dirs


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

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

parseUrl()

Parse URL and set controller properties


    public
                    parseUrl() : self

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

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

_addDealsPropertiesList()

Add items properties list to $parentObject


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

Parameters

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

Return values

self

Deal_Controller_Show extends Core_Controller in package HostCMS Deal

Tags

Table of Contents

Properties

Methods

Properties

$_aDeal_Properties

$_aDeal_Property_Dirs

$_allowedProperties

$_allowedTags

$_attributePrefix

$_cacheApplyForbiddenAllowedTags

$_cacheTags

$_Deals

$_entities

$_entity

$_forbiddenTags

$_mode

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

deals()

Return values

error404()

Return values

get()

Tags

Return values

getAllowedTags()

Deal_Controller_Show extends Core_Controller
in package

HostCMS

Deal