Documentation

Printlayout_Controller_Print extends Admin_Form_Action_Controller
in package

Printlayout_Controller_Print

Tags
subpackage

Printlayout

version
7.x
author

Hostmake LLC

copyright

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

Table of Contents

$_Admin_Form_Action  : Admin_Form_Action_Model
Form Action
$_Admin_Form_Controller  : Admin_Form_Controller
Form controller
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_children  : array<string|int, mixed>
Children entities list
$_content  : string
Content
$_datasetId  : int
Dataset ID
$_email  : mixed
Email
$_message  : string
Message text
$_newWindowId  : string
New window id
$_object  : mixed
Object
$_oMeta  : mixed
Core_Meta object
$_oPrintlayout_Controller  : mixed
Printlayout_Controller
$_propertiesValues  : array<string|int, mixed>
Properties values
$_rowsCount  : int
Row count
$_unlimitedProperties  : bool
Object has unlimited number of properties
__construct()  : mixed
Constructor.
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
addContent()  : self
Add content
addEntity()  : self
Add entity
addMessage()  : self
Add message
clearContent()  : self
Clear content
controller()  : self
Set Admin_Form_Controller
execute()  : self
Executes the business logic.
factory()  : object
Create and return controller for current skin
getChildren()  : array<string|int, mixed>
Get Children
getContent()  : object
Get content
getController()  : Admin_Form_Controller
Get Admin_Form_Controller
getDatasetId()  : int
Get dataset ID
getMessage()  : self
Get message
getName()  : string
Get action name
getObject()  : object
Get object
set()  : self
Run when writing data to inaccessible properties
setDatasetId()  : mixed
Set dataset ID
setObject()  : self
Set object
setUnlimitedProperties()  : self
Set unlimitedProperties
_prepare()  : self
Prepare
_print()  : self
Print
_send()  : mixed
Send
_showEditForm()  : bool
Show edit form

Properties

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array( 'title', // Form Title 'skipColumns', // Array of skipped columns 'buttonName', 'printlayout', 'send', )

$_children

Children entities list

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

$_content

Content

protected string $_content = \NULL

$_datasetId

Dataset ID

protected int $_datasetId = \NULL

$_email

Email

protected mixed $_email = \NULL

$_message

Message text

protected string $_message = \NULL

$_newWindowId

New window id

protected string $_newWindowId = 'id_content'

$_object

Object

protected mixed $_object = \NULL

$_oMeta

Core_Meta object

protected mixed $_oMeta = \NULL

$_oPrintlayout_Controller

Printlayout_Controller

protected mixed $_oPrintlayout_Controller = \NULL

$_propertiesValues

Properties values

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

$_rowsCount

Row count

protected int $_rowsCount = 0

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

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

addContent()

Add content

public addContent(string $content) : self
Parameters
$content : string

content

Return values
self

addMessage()

Add message

public addMessage( $message) : self
Parameters
$message :

message

Return values
self

clearContent()

Clear content

public clearContent() : self
Return values
self

execute()

Executes the business logic.

public execute([mixed $operation = NULL ]) : self
Parameters
$operation : mixed = NULL

Operation name

Return values
self

getChildren()

Get Children

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

getContent()

Get content

public getContent() : object
Return values
object

getDatasetId()

Get dataset ID

public getDatasetId() : int
Return values
int

getMessage()

Get message

public getMessage() : self
Return values
self

getName()

Get action name

public getName() : string
Return values
string

getObject()

Get object

public getObject() : object
Return values
object

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

setDatasetId()

Set dataset ID

public setDatasetId(int $datasetId) : mixed
Parameters
$datasetId : int

ID of dataset

Return values
mixed

setObject()

Set object

public setObject(object $object) : self
Parameters
$object : object

object

Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self

_prepare()

Prepare

protected abstract _prepare() : self
Return values
self

_print()

Print

protected abstract _print() : self
Return values
self

_send()

Send

protected _send() : mixed
Return values
mixed

_showEditForm()

Show edit form

protected _showEditForm() : bool
Return values
bool

Search results