Documentation

Deal_Controller_Show extends Core_Controller
in package

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

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

  • 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()
Tags
subpackage

Deal

version
7.x
author

Hostmake LLC

copyright

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

Table of Contents

$_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
$_attributePrefix  : string
Attribute's prefix
$_cacheTags  : array<string|int, mixed>
Cache tags
$_Deals  : Deals
Deals
$_entities  : array<string|int, mixed>
List of children entities
$_entity  : Core_Entity
Entity
$_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
__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
deals()  : Deal_Model
Get deals
error404()  : self
Define handler for 404 error
get()  : string
Get HTML based by entities tree, use XSL $this->_xsl
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
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
mode()  : self
Set mode
parseUrl()  : self
Parse URL and set controller properties
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

Properties

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

$_attributePrefix

Attribute's prefix

protected string $_attributePrefix = '_'

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

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

__construct()

Constructor.

public __construct(Site_Model $oSite) : mixed
Parameters
$oSite : Site_Model

site

Return values
mixed

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

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

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

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

mode()

Set mode

public mode(string $mode) : self
Parameters
$mode : string
Return values
self

parseUrl()

Parse URL and set controller properties

public parseUrl() : self
Tags
hostcms-event

Deal_Controller_Show.onBeforeParseUrl

hostcms-event

Deal_Controller_Show.onAfterParseUrl

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

Deal_Controller_Show.onBeforeRedeclaredShow

hostcms-event

Deal_Controller_Show.onBeforeAddPropertiesList

hostcms-event

Deal_Controller_Show.onBeforeAddDealsPropertiesList

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

Search results