Printlayout_Controller
extends Core_Controller
in package
Printlayout_Controller
Tags
Table of Contents
Properties
- $_allowedProperties : array<string|int, mixed>
- Allowed object properties
- $_allowedTags : array<string|int, mixed>
- Allowed tags for specified elements
- $_arrayReplace : array<string|int, mixed>
- Replace array
- $_attributePrefix : string
- Attribute's prefix
- $_cacheApplyForbiddenAllowedTags : array<string|int, mixed>
- Cache for applyForbiddenAllowedTags
- $_cacheTags : array<string|int, mixed>
- Cache tags
- $_documentPath : string
- Document xml path
- $_documentXml : string
- Document xml
- $_entities : array<string|int, mixed>
- List of children entities
- $_entity : Core_Entity
- Entity
- $_fileName : string|null
- File name
- $_filePath : string|null
- File path
- $_forbiddenTags : array<string|int, mixed>
- Forbidden tags for specified elements
- $_mode : string
- Controller's mode
- $_oPrintlayout : object
- Printlayout model
- $_propertiesValues : array<string|int, mixed>
- Properties values
- $_scalarReplace : array<string|int, mixed>
- Scalar replace
- $_shownIDs : array<string|int, mixed>
- Shown IDs
- $_tpl : Tpl_Model
- TPL
- $_trToReplace : array<string|int, mixed>
- tr to replace
- $_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
- deleteFile() : self
- Delete file
- downloadFile() : mixed
- Download file
- execute() : mixed
- get() : string
- Get HTML based by entities tree, use XSL $this->_xsl
- getAllowedTags() : array<string|int, mixed>
- Get allowed tags list
- getBackendPrintButton() : Admin_Form_Entity
- Get backend print button
- getCacheTags() : array<string|int, mixed>
- Get Cache Tags
- getEntities() : array<string|int, mixed>
- Get enities
- getEntity() : object
- Get entity
- getFileName() : string
- Get file name
- getFilePath() : string
- Get file path
- getForbiddenTags() : array<string|int, mixed>
- Get forbidden tags list
- getPrintButtonHtml() : string
- Get print button
- 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
- printFile() : mixed
- Print file
- 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
- _generateDocx() : string
- Generate docx file
- _getArrayByRpr() : array<string|int, mixed>
- Get array by RPR
- _getError() : mixed
- _getXml() : mixed
- _unionNodes() : array<string|int, mixed>
- Union nodes
Properties
$_allowedProperties
Allowed object properties
protected
array<string|int, mixed>
$_allowedProperties
= array('driver', 'replace', 'entity')
$_allowedTags
Allowed tags for specified elements
protected
array<string|int, mixed>
$_allowedTags
= array()
$_arrayReplace
Replace array
protected
array<string|int, mixed>
$_arrayReplace
= 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()
$_documentPath
Document xml path
protected
string
$_documentPath
= 'word/document.xml'
$_documentXml
Document xml
protected
string
$_documentXml
= \NULL
$_entities
List of children entities
protected
array<string|int, mixed>
$_entities
= array()
$_entity
Entity
protected
Core_Entity
$_entity
= \NULL
$_fileName
File name
protected
string|null
$_fileName
= \NULL
$_filePath
File path
protected
string|null
$_filePath
= \NULL
$_forbiddenTags
Forbidden tags for specified elements
protected
array<string|int, mixed>
$_forbiddenTags
= array()
$_mode
Controller's mode
protected
string
$_mode
= 'json'
$_oPrintlayout
Printlayout model
protected
object
$_oPrintlayout
= \NULL
$_propertiesValues
Properties values
protected
array<string|int, mixed>
$_propertiesValues
= array()
$_scalarReplace
Scalar replace
protected
array<string|int, mixed>
$_scalarReplace
= array()
$_shownIDs
Shown IDs
protected
array<string|int, mixed>
$_shownIDs
= array()
$_tpl
TPL
protected
Tpl_Model
$_tpl
= \NULL
$_trToReplace
tr to replace
protected
array<string|int, mixed>
$_trToReplace
= 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()
$_xsl
XSL
protected
Xsl_Model
$_xsl
= \NULL
Methods
__construct()
Constructor.
public
__construct(Printlayout_Model $oPrintlayout) : mixed
Parameters
- $oPrintlayout : Printlayout_Model
-
print layout
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
selfaddAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
selfaddAllowedTag()
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
selfaddAllowedTags()
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
selfaddCacheSignature()
Add additional signature for cache name
public
addCacheSignature(string $name) : self
Parameters
- $name : string
-
name
Return values
selfaddCacheTag()
Add Cache Tag
public
addCacheTag(string $tagName) : self
Parameters
- $tagName : string
Return values
selfaddEntities()
Add enities
public
addEntities(array<string|int, mixed> $aChildrenEntities) : self
Parameters
- $aChildrenEntities : array<string|int, mixed>
-
entities
Return values
selfaddEntity()
Add a children entity
public
addEntity(Core_Entity $oChildrenEntity) : self
Parameters
- $oChildrenEntity : Core_Entity
Return values
selfaddForbiddenTag()
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
selfaddForbiddenTags()
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
selfappend()
Append an element to an assigned array
public
append(mixed $varname, mixed $var) : self
Parameters
- $varname : mixed
- $var : mixed
Return values
selfapplyForbiddenAllowedTags()
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
selfassign()
Assign variables/objects to the TPL-template
public
assign(mixed $varname, mixed $var) : self
Parameters
- $varname : mixed
- $var : mixed
Return values
selfclearCacheTag()
Clear Cache Tag
public
clearCacheTag() : self
Return values
selfclearEntities()
Clear enities
public
clearEntities() : self
Return values
selfclearVars()
Clear vars
public
clearVars() : self
Return values
selfdeleteFile()
Delete file
public
deleteFile() : self
Return values
selfdownloadFile()
Download file
public
downloadFile() : mixed
execute()
public
execute() : mixed
get()
Get HTML based by entities tree, use XSL $this->_xsl
public
get() : string
Tags
Return values
stringgetAllowedTags()
Get allowed tags list
public
getAllowedTags() : array<string|int, mixed>
Return values
array<string|int, mixed>getBackendPrintButton()
Get backend print button
public
static getBackendPrintButton(Admin_Form_Controller $oAdmin_Form_Controller, int $id, int $type) : Admin_Form_Entity
Parameters
- $oAdmin_Form_Controller : Admin_Form_Controller
- $id : int
- $type : int
Return values
Admin_Form_EntitygetCacheTags()
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
objectgetFileName()
Get file name
public
getFileName() : string
Return values
stringgetFilePath()
Get file path
public
getFilePath() : string
Return values
stringgetForbiddenTags()
Get forbidden tags list
public
getForbiddenTags() : array<string|int, mixed>
Return values
array<string|int, mixed>getPrintButtonHtml()
Get print button
public
static getPrintButtonHtml(Admin_Form_Controller $Admin_Form_Controller, int $module_id, int $type, string $additionalParam[, bool $divider = FALSE ]) : string
Parameters
- $Admin_Form_Controller : Admin_Form_Controller
- $module_id : int
- $type : int
- $additionalParam : string
- $divider : bool = FALSE
Return values
stringgetShownIDs()
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_ModelgetXml()
Get XML for entity and children entities
public
getXml() : string
Return values
stringgetXsl()
Get XSL
public
getXsl() : Xsl_Model
Return values
Xsl_ModelisAllowedTag()
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
boolisForbiddenTag()
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
boolmode()
Set mode
public
mode(string $mode) : self
Parameters
- $mode : string
Return values
selfprintFile()
Print file
public
printFile() : mixed
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
selfremoveForbiddenTag()
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
selfset()
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
selfsetAttributePrefix()
Change attributePrefix
public
setAttributePrefix(string $attributePrefix) : self
Parameters
- $attributePrefix : string
Return values
selfsetEntity()
Set entity
public
setEntity(Core_Entity $entity) : self
Parameters
- $entity : Core_Entity
-
entity
Return values
selfsetUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR
Return values
selfshow()
Show built data
public
show() : self
Tags
Return values
selftpl()
Set TPL
public
tpl(Tpl_Model|string $tpl) : self
Parameters
- $tpl : Tpl_Model|string
Return values
selfxsl()
Set XSL
public
xsl(Xsl_Model|string $xsl) : self
Parameters
- $xsl : Xsl_Model|string
Return values
self_generateDocx()
Generate docx file
protected
_generateDocx() : string
Tags
Return values
string —Generated File Path
_getArrayByRpr()
Get array by RPR
protected
_getArrayByRpr(object $object) : array<string|int, mixed>
Parameters
- $object : object
Return values
array<string|int, mixed>_getError()
protected
_getError(mixed $code) : mixed
Parameters
- $code : mixed
_getXml()
protected
_getXml() : mixed
_unionNodes()
Union nodes
protected
_unionNodes(object $oXml) : array<string|int, mixed>
Parameters
- $oXml : object