Documentation

Structure_Controller_Edit extends Admin_Form_Action_Controller_Type_Edit
in package

Structure Backend Editing Controller.

Tags
subpackage

Structure

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
$_Admin_Form_Entity_Form  : Admin_Form_Entity_Form
Form
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_children  : array<string|int, mixed>
Children entities list
$_content  : string
Content
$_datasetId  : int
Dataset ID
$_fields  : array<string|int, mixed>
Form fields
$_formId  : string
Form's ID
$_formValues  : mixed
Stores POST, which can change the controller
$_keys  : array<string|int, mixed>
Model's key list
$_message  : string
Message text
$_object  : object
Object
$_prepeared  : mixed
$_propertiesValues  : array<string|int, mixed>
Properties values
$_return  : mixed
Return
$_tabs  : array<string|int, mixed>
Form tabs
$_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
addField()  : self
Add field
addMessage()  : self
Add message
addSkipColumn()  : self
Add skiping column
addTab()  : self
Add new tab into form
addTabAfter()  : self
Add new tab into form after $oAdmin_Form_Entity_Tab_After
addTabBefore()  : self
Add new tab into form before $oAdmin_Form_Entity_Tab_Before
clearContent()  : self
Clear content
controller()  : self
Set Admin_Form_Controller
deleteTab()  : self
Delete tab
execute()  : mixed
Execute operation $operation
factory()  : object
Create and return controller for current skin
fillStructureList()  : array<string|int, mixed>
Create visual tree of the directories
getChildren()  : array<string|int, mixed>
Get Children
getContent()  : object
Get content
getController()  : Admin_Form_Controller
Get Admin_Form_Controller
getDatasetId()  : int
Get dataset ID
getField()  : Admin_Form_Entity
Get form field by name
getFields()  : array<string|int, mixed>
Get all ordinary fields, created by table's fileds
getFormValues()  : array<string|int, mixed>
Get _formValues
getMessage()  : self
Get message
getName()  : string
Get action name
getObject()  : object
Get object
getTab()  : Admin_Form_Entity_Tab
Get tab
getTabs()  : array<string|int, mixed>
Get all tabs
issetTab()  : bool
Check is tab isset
moveTabAfter()  : self
Move tab after some another tab
moveTabBefore()  : self
Move tab before some another tab
removeSkipColumn()  : self
Remove skiping column
set()  : self
Run when writing data to inaccessible properties
setDatasetId()  : mixed
Set dataset ID
setFormValues()  : self
Set _formValues
setObject()  : self
Set object
setReturn()  : self
Set return
setUnlimitedProperties()  : self
Set unlimitedProperties
_addButtons()  : Admin_Form_Entity_Buttons
Add form buttons
_addUserIdField()  : mixed
Add user_id field
_applyObjectProperty()  : self
Processing of the form. Apply object fields.
_correctValue()  : mixed
Correct Value by $columnArray
_deleteAutosave()  : self
Delete autosave
_fillMenuList()  : array<string|int, mixed>
Fill menus list
_getAdmin_Form_Entity_Tabs()  : Admin_Form_Entity_Tabs|null
Get Admin_Form_Entity_Tabs
_getApplyButton()  : Admin_Form_Entity_Buttons
Get apply button
_getSaveButton()  : Admin_Form_Entity_Buttons
Get save button
_loadKeys()  : self
Get model's key list Получение списка ключей модели (PK и FK)
_prepareForm()  : self
Prepare backend item's edit form
_showEditForm()  : bool
Show edit form

Properties

$_allowedProperties

Allowed object properties

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

$_children

Children entities list

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

$_content

Content

protected string $_content = \NULL

$_datasetId

Dataset ID

protected int $_datasetId = \NULL

$_fields

Form fields

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

$_formId

Form's ID

protected string $_formId = \NULL

$_formValues

Stores POST, which can change the controller

protected mixed $_formValues = \NULL

$_keys

Model's key list

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

$_message

Message text

protected string $_message = \NULL

$_object

Object

protected object $_object = \NULL

$_prepeared

protected mixed $_prepeared = \FALSE

$_propertiesValues

Properties values

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

$_return

Return

protected mixed $_return = \NULL

$_tabs

Form tabs

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

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

Methods

__construct()

Constructor.

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

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

addSkipColumn()

Add skiping column

public addSkipColumn(string $column) : self
Parameters
$column : string

column name

Return values
self

clearContent()

Clear content

public clearContent() : self
Return values
self

deleteTab()

Delete tab

public deleteTab(string $tabName) : self
Parameters
$tabName : string

Name of tab

Return values
self

execute()

Execute operation $operation

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

Operation name

Return values
mixed

fillStructureList()

Create visual tree of the directories

public fillStructureList(int $iSiteId, int $iParentId[, bool $bExclude = FALSE ], int $iLevel) : array<string|int, mixed>
Parameters
$iSiteId : int

site ID

$iParentId : int

parent directory ID

$bExclude : bool = FALSE

exclude group ID

$iLevel : int

current nesting level

Return values
array<string|int, mixed>

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

getFields()

Get all ordinary fields, created by table's fileds

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

getFormValues()

Get _formValues

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

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

getTabs()

Get all tabs

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

issetTab()

Check is tab isset

public issetTab(string $tabName) : bool
Parameters
$tabName : string

tab name

Return values
bool

removeSkipColumn()

Remove skiping column

public removeSkipColumn(string $column) : self
Parameters
$column : string

column name

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

setDatasetId()

Set dataset ID

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

ID of dataset

Return values
mixed

setFormValues()

Set _formValues

public setFormValues(array<string|int, mixed> $values) : self
Parameters
$values : array<string|int, mixed>
Return values
self

setObject()

Set object

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

object

Return values
self

setReturn()

Set return

public setReturn(mixed $return) : self
Parameters
$return : mixed
Return values
self

setUnlimitedProperties()

Set unlimitedProperties

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

default TRUR

Return values
self

_addUserIdField()

Add user_id field

protected _addUserIdField(Admin_Form_Entity_Model $oAdmin_Form_Entity, string $sTabName) : mixed
Parameters
$oAdmin_Form_Entity : Admin_Form_Entity_Model
$sTabName : string
Return values
mixed

_applyObjectProperty()

Processing of the form. Apply object fields.

protected _applyObjectProperty() : self
Tags
hostcms-event

Structure_Controller_Edit.onAfterRedeclaredApplyObjectProperty

Return values
self

_correctValue()

Correct Value by $columnArray

protected _correctValue(mixed $value, array<string|int, mixed> $columnArray) : mixed
Parameters
$value : mixed
$columnArray : array<string|int, mixed>
Return values
mixed

_deleteAutosave()

Delete autosave

protected _deleteAutosave() : self
Return values
self

_fillMenuList()

Fill menus list

protected _fillMenuList(int $iSiteId) : array<string|int, mixed>
Parameters
$iSiteId : int

site ID

Return values
array<string|int, mixed>

_loadKeys()

Get model's key list Получение списка ключей модели (PK и FK)

protected _loadKeys() : self
Return values
self

_prepareForm()

Prepare backend item's edit form

protected _prepareForm() : self
Return values
self

_showEditForm()

Show edit form

protected _showEditForm() : bool
Return values
bool

Search results