Documentation

Helpdesk_Controller_Show extends Core_Controller
in package

Показ службы прддержки.

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

  • category($id) идентификатор категории, из которой выводить тикеты
  • ticket($id) идентификатор тикета, из которой выводить сообщения
  • ticketsForbiddenTags(array('source')) массив тегов тикета, запрещенных к передаче в генерируемый XML
  • offset($offset) смещение, с которого выводить тикеты. По умолчанию 0
  • limit($limit) количество выводимых элементов
  • page(2) текущая страница, по умолчанию 0, счет ведется с 0
  • criticalityLevels(TRUE|FALSE) показывать уровни критичности
  • messageSortingDirection() направление сортировки сообщений, 0 - ASC, 1 - DESC
  • messageSortingField() поле сортировки сообщений, 0 - sorting, 1 - datetime

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

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

Helpdesk

version
7.x
author

Hostmake LLC

copyright

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

Table of Contents

$_aHelpdesk_Categories  : Helpdesk_Category_Model
List of helpdesk categories
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_attributePrefix  : string
Attribute's prefix
$_cacheTags  : array<string|int, mixed>
Cache tags
$_entities  : array<string|int, mixed>
List of children entities
$_entity  : Core_Entity
Entity
$_Helpdesk_Categories  : Helpdesk_Categor
Helpdesk's categories object
$_Helpdesk_Tickets  : Helpdesk_Ticket_Model
Helpdesk's tickets object
$_mode  : string
Controller's mode
$_propertiesValues  : array<string|int, mixed>
Properties values
$_shownIDs  : array<string|int, mixed>
Shown IDs
$_Siteuser  : Siteuser_Model
Current user
$_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.
addAllCategories()  : self
Add all categories to controller
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
applyTicketsForbiddenTags()  : self
Apply forbidden tags for ticket
assign()  : self
Assign variables/objects to the TPL-template
clearCacheTag()  : self
Clear Cache Tag
clearEntities()  : self
Clear enities
clearVars()  : self
Clear vars
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
getCacheTags()  : array<string|int, mixed>
Get Cache Tags
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
helpdeskCategories()  : Helpdesk_Ticket_Model
Get helpdesk categories
helpdeskTickets()  : Helpdesk_Ticket_Model
Get helpdesk tickets
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
_addCategoriesByParentId()  : self
Add categories subtree to $parentObject

Properties

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('category', 'ticket', 'ticketsForbiddenTags', 'offset', 'limit', 'page', 'total', 'worktime', 'pattern', 'patternParams', 'criticalityLevels', 'messageSortingDirection', 'messageSortingField')

$_attributePrefix

Attribute's prefix

protected string $_attributePrefix = '_'

$_cacheTags

Cache tags

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

$_entities

List of children entities

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

$_Helpdesk_Categories

Helpdesk's categories object

protected Helpdesk_Categor $_Helpdesk_Categories = \NULL

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

addAllCategories()

Add all categories to controller

public addAllCategories() : self
Return values
self

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

applyTicketsForbiddenTags()

Apply forbidden tags for ticket

public applyTicketsForbiddenTags(Helpdesk_Ticket $oHelpdesk_Ticket) : self
Parameters
$oHelpdesk_Ticket : Helpdesk_Ticket

ticket

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

getCacheTags()

Get Cache Tags

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

Helpdesk_Controller_Show.onBeforeParseUrl

hostcms-event

Helpdesk_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

Helpdesk_Controller_Show.onBeforeRedeclaredShow

Return values
self

_addCategoriesByParentId()

Add categories subtree to $parentObject

protected _addCategoriesByParentId(int $parent_id, object $parentObject) : self
Parameters
$parent_id : int

root of subtree

$parentObject : object

object

Return values
self

Search results