Documentation

Chartaccount_Controller_Edit extends Admin_Form_Action_Controller_Type_Edit
in package

HostCMS

Chartaccount

Chartaccount Type Backend Editing Controller.

Properties

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

Methods

__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() : bool: 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
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
setFormValue() : self: Set _formValues $key
setFormValues() : self: Set _formValues
setObject() : Admin_Form_Action_Controller_Type_Edit: Load object's fields when object has been set После установки объекта загружаются данные о его полях
setReturn() : self: Set return
setUnlimitedProperties() : self: Set unlimitedProperties
_addButtons() : Admin_Form_Entity_Buttons: Add form buttons
_addCsrfToken() : mixed: Add CSRF token
_addUserIdField() : mixed: Add user_id field
_applyObjectProperty() : self: Processing of the form. Apply object fields.
_checkCsrf() : mixed: Check CSRF token
_correctValue() : mixed: Correct Value by $columnArray
_deleteAutosave() : self: Delete autosave
_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

$_Admin_Form_Action

Form Action


    protected
        Admin_Form_Action_Model
    $_Admin_Form_Action
     = \NULL

$_Admin_Form_Controller

Form controller


    protected
        Admin_Form_Controller
    $_Admin_Form_Controller
     = \NULL

$_Admin_Form_Entity_Form

Form


    protected
        Admin_Form_Entity_Form
    $_Admin_Form_Entity_Form
     = \NULL

$_allowedProperties

Allowed object properties


    protected
        array<string|int, mixed>
    $_allowedProperties
     = array(
    'title',
    // Form Title
    'pageTitle',
    // Form Title
    'skipColumns',
    // Array of skipped columns
    'tabClass',
    // Additional class for Admin_Form_Entity_Tab
    'tabsClass',
    // Additional class for Admin_Form_Entity_Tabs
    'autosave',
)

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

__construct()

Constructor.


    public
                    __construct(Admin_Form_Action_Model $oAdmin_Form_Action) : mixed

Parameters

$oAdmin_Form_Action : Admin_Form_Action_Model: action

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

addEntity()

Add entity


    public
                    addEntity(Admin_Form_Entity $oAdmin_Form_Entity) : self

Parameters

$oAdmin_Form_Entity : Admin_Form_Entity

Return values

self

addField()

Add field


    public
                    addField(Admin_Form_Entity $oAdmin_Form_Entity) : self

Parameters

$oAdmin_Form_Entity : Admin_Form_Entity: field

Return values

self

addMessage()

Add message


    public
                    addMessage(mixed $message) : self

Parameters

$message : mixed: message

Return values

self

addSkipColumn()

Add skiping column


    public
                    addSkipColumn(string $column) : self

Parameters

$column : string: column name

Return values

self

addTab()

Add new tab into form


    public
                    addTab(Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab) : self

Parameters

$oAdmin_Form_Entity_Tab : Skin_Default_Admin_Form_Entity_Tab: new tab

Return values

self

addTabAfter()

Add new tab into form after $oAdmin_Form_Entity_Tab_After


    public
                    addTabAfter(Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab, Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab_After) : self

Parameters

$oAdmin_Form_Entity_Tab : Skin_Default_Admin_Form_Entity_Tab: new tab
$oAdmin_Form_Entity_Tab_After : Skin_Default_Admin_Form_Entity_Tab: old tab

Return values

self

addTabBefore()

Add new tab into form before $oAdmin_Form_Entity_Tab_Before


    public
                    addTabBefore(Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab, Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab_Before) : self

Parameters

$oAdmin_Form_Entity_Tab : Skin_Default_Admin_Form_Entity_Tab: new tab
$oAdmin_Form_Entity_Tab_Before : Skin_Default_Admin_Form_Entity_Tab: old tab

Return values

self

clearContent()

Clear content


    public
                    clearContent() : self

Return values

self

controller()

Set Admin_Form_Controller


    public
                    controller(Admin_Form_Controller $oAdmin_Form_Controller) : self

Parameters

$oAdmin_Form_Controller : Admin_Form_Controller

Return values

self

deleteTab()

Delete tab


    public
                    deleteTab(string $tabName) : self

Parameters

$tabName : string: Name of tab

Return values

self

execute()

Executes the business logic.


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

Parameters

$operation : mixed = NULL: Operation for action

Return values

bool

factory()

Create and return controller for current skin


    public
            static        factory(string $className, Admin_Form_Action_Model $oAdmin_Form_Action) : object

Parameters

$className : string: name of class
$oAdmin_Form_Action : Admin_Form_Action_Model: action

Return values

object

getChildren()

Get Children


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

Return values

array<string|int, mixed>

getContent()

Get content


    public
                    getContent() : object

Return values

object

getController()

Get Admin_Form_Controller


    public
                    getController() : Admin_Form_Controller

Return values

Admin_Form_Controller

getDatasetId()

Get dataset ID


    public
                    getDatasetId() : int

Return values

int

getField()

Get form field by name


    public
                    getField(string $fieldName) : Admin_Form_Entity

Parameters

$fieldName : string: name

Return values

Admin_Form_Entity

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

getTab()

Get tab


    public
                    getTab(string $tabName) : Admin_Form_Entity_Tab

Parameters

$tabName : string

Return values

Admin_Form_Entity_Tab

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

moveTabAfter()

Move tab after some another tab


    public
                    moveTabAfter(Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab, Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab_After) : self

Parameters

$oAdmin_Form_Entity_Tab : Skin_Default_Admin_Form_Entity_Tab: tab you want to move
$oAdmin_Form_Entity_Tab_After : Skin_Default_Admin_Form_Entity_Tab: tab after which you want to place

Return values

self

moveTabBefore()

Move tab before some another tab


    public
                    moveTabBefore(Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab, Skin_Default_Admin_Form_Entity_Tab $oAdmin_Form_Entity_Tab_Before) : self

Parameters

$oAdmin_Form_Entity_Tab : Skin_Default_Admin_Form_Entity_Tab: tab you want to move
$oAdmin_Form_Entity_Tab_Before : Skin_Default_Admin_Form_Entity_Tab: tab before which you want to place

Return values

self

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

setFormValue()

Set _formValues $key


    public
                    setFormValue(string $key, string $value) : self

Parameters

$key : string
$value : string

Return values

self

setFormValues()

Set _formValues


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

Parameters

$values : array<string|int, mixed>

Return values

self

setObject()

Load object's fields when object has been set После установки объекта загружаются данные о его полях


    public
                    setObject(object $object) : Admin_Form_Action_Controller_Type_Edit

Parameters

$object : object

Return values

Admin_Form_Action_Controller_Type_Edit

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

_addButtons()

Add form buttons


    protected
                    _addButtons() : Admin_Form_Entity_Buttons

Return values

Admin_Form_Entity_Buttons

_addCsrfToken()

Add CSRF token


    protected
                    _addCsrfToken() : mixed

_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

_applyObjectProperty()

Processing of the form. Apply object fields.


    protected
                    _applyObjectProperty() : self

Return values

self

_checkCsrf()

Check CSRF token


    protected
                    _checkCsrf(string $secret_csrf) : mixed

Parameters

$secret_csrf : string

_correctValue()

Correct Value by $columnArray


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

Parameters

$value : mixed
$columnArray : array<string|int, mixed>

_deleteAutosave()

Delete autosave


    protected
                    _deleteAutosave() : self

Return values

self

_getAdmin_Form_Entity_Tabs()

Get Admin_Form_Entity_Tabs


    protected
                    _getAdmin_Form_Entity_Tabs() : Admin_Form_Entity_Tabs|null

Return values

Admin_Form_Entity_Tabs|null

_getApplyButton()

Get apply button


    protected
                    _getApplyButton() : Admin_Form_Entity_Buttons

Return values

Admin_Form_Entity_Buttons

_getSaveButton()

Get save button


    protected
                    _getSaveButton() : Admin_Form_Entity_Buttons

Return values

Admin_Form_Entity_Buttons

_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

Chartaccount_Controller_Edit extends Admin_Form_Action_Controller_Type_Edit in package HostCMS Chartaccount

Tags

Table of Contents

Properties

Methods

Properties

$_Admin_Form_Action

$_Admin_Form_Controller

$_Admin_Form_Entity_Form

$_allowedProperties

$_children

$_content

$_datasetId

$_fields

$_formId

$_formValues

$_keys

$_message

$_object

$_prepeared

$_propertiesValues

$_return

$_tabs

$_unlimitedProperties

Methods

__construct()

Parameters

addAllowedProperties()

Parameters

Return values

addAllowedProperty()

Parameters

Return values

addContent()

Parameters

Return values

addEntity()

Parameters

Return values

addField()

Parameters

Return values

addMessage()

Parameters

Return values

addSkipColumn()

Parameters

Return values

addTab()

Parameters

Return values

addTabAfter()

Parameters

Return values

addTabBefore()

Parameters

Return values

clearContent()

Return values

controller()

Parameters

Return values

deleteTab()

Parameters

Return values

execute()

Parameters

Tags

Return values

factory()

Parameters

Return values

getChildren()

Return values

getContent()

Return values

getController()

Return values

getDatasetId()

Return values

Chartaccount_Controller_Edit extends Admin_Form_Action_Controller_Type_Edit
in package

HostCMS

Chartaccount