Documentation

Chartaccount_Entry_Subcount_Model extends Core_Entity
in package

HostCMS

Chartaccount

Chartaccount_Entry_Subcount_Model

Properties

$config : mixed: ORM config
$_allowedTags : array<string|int, mixed>: Allowed tags. If list of tags is empty, all tags will show.
$_attributes : array<string|int, mixed>: Entity Attributes
$_belongsTo : array<string|int, mixed>: Belongs to relations
$_changeCopiedName : bool: Change copied name is necessary, default FALSE
$_changedColumns : array<string|int, mixed>: List of changed columns
$_dataValues : array<string|int, mixed>: data-values, e.g. dataMyValue
$_forbiddenTags : array<string|int, mixed>: Forbidden tags. If list of tags is empty, all tags will be shown.
$_hasMany : array<string|int, mixed>: One-to-many or many-to-many relations
$_hasOne : array<string|int, mixed>: One-to-one relations
$_hasRevisions : mixed: Has revisions
$_marksDeleted : mixed: Disable markDeleted()
$_modelColumns : array<string|int, mixed>: List of columns in model with values
$_modelName : mixed: Model name
$_nameColumn : string: Column consist item's name
$_preloadValues : array<string|int, mixed>: List of preloaded values those will set for new object which does not have primary key
$_primaryKey : string: Primary key
$_queryBuilder : Core_QueryBuilder_Select: Select query builder
$_shortcodeTags : array<string|int, mixed>: List of Shortcodes tags
$_skipColumns : array<string|int, mixed>: List of skipped columns from table
$_sorting : array<string|int, mixed>: Default sorting for models <code> protected $_sorting = array( 'tablename.sorting' => 'ASC' ); </code>
$_tableColumns : array<string|int, mixed>: List of columns in table
$_tableName : mixed: Table name, e.g. 'books' for 'Book_Model'
$_typicalForbiddenTags : array<string|int, mixed>: Typical forbidden tags.

Methods

__call() : mixed: Triggered when invoking inaccessible methods in an object context
__construct() : mixed: Constructor.
add() : self: Add related object. If main object does not save, it will save.
addAllowedTag() : self: Add tag to allowed tags list
addAllowedTags() : self: Add tags to allowed tags list
addAttribute() : self: Add entity attribute
addEntities() : self: Add children entities
addEntity() : self: Add a children entity
addForbiddenTag() : self: Add tag to forbidden tags list
addForbiddenTags() : self: Add tags to forbidden tags list
addXmlTag() : self: Add external tag for entity
applyMarksDeleted() : self: Apply markDeleted flag if is set
changeCopiedName() : self: Set if change copied name is necessary
changed() : bool: Check model has been changed.
check() : self: Check model values. If model has incorrect value, one will correct or call exception.
chunk() : bool: Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE
clear() : self: Clear object
clearEntities() : self: Clear enities
clearEntitiesAfterGetXml() : self: Clear all entities after XML generation
clearXmlTags() : mixed: Clear external XML tags for entity.
copy() : new: Copy object
create() : self: Insert new object data into database
delete() : self: Delete object from database
deleteAll() : self: Delete all object
factory() : mixed: Create and return an object of model
find() : self: Find object in database and load one
findAll() : array<string|int, mixed>: Find all objects
getAllowedTags() : array<string|int, mixed>: Get allowed tags list
getChangedData() : array<string|int, mixed>: Get changed columns with values
getClassName() : string: Get Model CallsName
getCount() : int: Get count object
getDatabaseDriver() : string: Get name of Database Driver
getDataValues() : array<string|int, mixed>: Get dataValues
getEntities() : array<string|int, mixed>: Get children entities
getFieldIDs() : array<string|int, mixed>: Get visible field's IDs
getFields() : array<string|int, mixed>: Get field's values
getFirst() : null|Core_ORM: Get fist entity, ordered by primary key
getForbiddenTags() : array<string|int, mixed>: Get forbidden tags list
getLast() : null|Core_ORM: Get last entity, ordered by primary key
getMarksDeleted() : string: Get column name for marks deleted
getModelName() : string: Get model name, e.g. 'book' for 'Book_Model'
getName() : string: Get entity name
getNameColumn() : string: Get Name Column
getPrimaryKey() : mixed: Get primary key value
getPrimaryKeyName() : string: Get primary key name
getRelatedSite() : Site_Model|null: Get Related Site
getRelations() : array<string|int, mixed>: Get all relations of entity
getStdObject() : stdObject: Get stdObject for entity and children entities
getTableColumns() : array<string|int, mixed>: Get tableColumns
getTableColums() : array<string|int, mixed>: Get table columns. Fix wrong method name
getTableName() : string: Get table name
getTrashDescription() : string: Get entity description
getXml() : string: Get XML for entity and children entities
getXmlTagName() : string: Get tag name
getXmlTags() : array<string|int, mixed>: Get external XML tags for entity.
isCallable() : bool: Verify that the contents of a variable can be called as a function
isEmptyPrimaryKey() : bool: Check is primary key NULL
markDeleted() : self: Mark entity as deleted
queryBuilder() : Core_QueryBuilder_Select: Get query builder for select
remove() : self: Remove related object. If main object does not save, it will save.
removeAllowedTag() : self: Remove tag from allowed tags list
removeForbiddenTag() : self: Remove tag from forbidden tags list
save() : self: Save object. Uses self::update() or self::create()
setCheck() : self: Set _check flag
setDatabaseDriver() : mixed: Set name of Database Driver
setMarksDeleted() : self: Set column name for marks deleted
setRelations() : self: Set $this->_relations
setTableName() : selg: Set table name
setXmlTagName() : self: Set name of XML node
toArray() : array<string|int, mixed>: Convert Object to Array
undelete() : self: Turn off deleted status
update() : self: Update object data into database
_getCopiedName() : mixed: Get the name of a new copied object
_isTagAvailable() : bool: Is $tagName Available
getDatabase() : Core_DataBase: Get Database

$config

ORM config


    public
    static    mixed
    $config
     = \NULL

$_allowedTags

Allowed tags. If list of tags is empty, all tags will show.


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

$_attributes

Entity Attributes


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

$_belongsTo

Belongs to relations


    protected
        array<string|int, mixed>
    $_belongsTo
     = array('chartaccount_entry' => array())

$_changeCopiedName

Change copied name is necessary, default FALSE


    protected
        bool
    $_changeCopiedName
     = \FALSE

$_changedColumns

List of changed columns


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

$_dataValues

data-values, e.g. dataMyValue


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

$_forbiddenTags

Forbidden tags. If list of tags is empty, all tags will be shown.


    protected
        array<string|int, mixed>
    $_forbiddenTags
     = array('deleted', 'user_id')

$_hasMany

One-to-many or many-to-many relations


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

One-to-many relation // Relation one-to-many for Book-Comments: protected $_hasMany = array('comment' => array());


// Equivalence relation one-to-many for Book-Comments with detailed conditions:
// comment - Model name
// foreign_key - Foreign key
protected $_hasMany = array('comment' => array(
'foreign_key' => 'book_id'
	));

Many-to-many relation // Relation many-to-many for Book-Comments through model 'books_comment': protected $_hasMany = array('comment' => array( 'through' => 'books_comment' ));


// Relation many-to-many for Book-Comments through model 'books_comment' with detailed conditions:
protected $_hasMany = array('comment' => array(
'foreign_key' => 'book_id',
'through' => 'books_comment',
'dependent_key' => 'comment_id'
	));

$_hasOne

One-to-one relations


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


// Relation one-to-one for Book-Comment:
protected $_hasOne = array('comment' => array());


// Equivalence relation one-to-one for Book-Comment with detailed conditions:
// comment - Model name
// foreign_key - Foreign key
protected $_hasOne = array('comment' => array(
'foreign_key' => 'book_id'
	));

$_hasRevisions

Has revisions


    protected
        mixed
    $_hasRevisions
     = \FALSE

$_marksDeleted

Disable markDeleted()


    protected
        mixed
    $_marksDeleted
     = \NULL

$_modelColumns

List of columns in model with values


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

$_modelName

Model name


    protected
        mixed
    $_modelName
     = 'chartaccount_entry_subcount'

$_nameColumn

Column consist item's name


    protected
        string
    $_nameColumn
     = 'name'

$_preloadValues

List of preloaded values those will set for new object which does not have primary key


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

$_primaryKey

Primary key


    protected
        string
    $_primaryKey
     = 'id'

$_queryBuilder

Select query builder


    protected
        Core_QueryBuilder_Select
    $_queryBuilder
     = \NULL

$_shortcodeTags

List of Shortcodes tags


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

$_skipColumns

List of skipped columns from table


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

$_sorting

Default sorting for models <code> protected $_sorting = array( 'tablename.sorting' => 'ASC' ); </code>


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

$_tableColumns

List of columns in table


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

$_tableName

Table name, e.g. 'books' for 'Book_Model'


    protected
        mixed
    $_tableName
     = \NULL

$_typicalForbiddenTags

Typical forbidden tags.


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

__call()

Triggered when invoking inaccessible methods in an object context


    public
                    __call(string $name, array<string|int, mixed> $arguments) : mixed

Parameters

$name : string: method name
$arguments : array<string|int, mixed>: arguments

__construct()

Constructor.


    public
                    __construct([string $primaryKey = NULL ]) : mixed

Parameters

$primaryKey : string = NULL

add()

Add related object. If main object does not save, it will save.


    public
                    add(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

addAllowedTag()

Add tag to allowed tags list


    public
                    addAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addAllowedTags()

Add tags to allowed tags list


    public
                    addAllowedTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addAttribute()

Add entity attribute


    public
                    addAttribute(string $name, string $value) : self

Parameters

$name : string
$value : string

Return values

self

addEntities()

Add children entities


    public
                    addEntities(array<string|int, mixed> $aChildrenEntities) : self

Parameters

$aChildrenEntities : array<string|int, mixed>

Return values

self

addEntity()

Add a children entity


    public
                    addEntity(Core_Entity $oChildrenEntity) : self

Parameters

$oChildrenEntity : Core_Entity

Return values

self

addForbiddenTag()

Add tag to forbidden tags list


    public
                    addForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addForbiddenTags()

Add tags to forbidden tags list


    public
                    addForbiddenTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addXmlTag()

Add external tag for entity


    public
                    addXmlTag(string $tagName, string $tagValue[, array<string|int, mixed> $attributes = array() ]) : self

Parameters

$tagName : string: tag name
$tagValue : string: tag value
$attributes : array<string|int, mixed> = array(): attributes

Return values

self

applyMarksDeleted()

Apply markDeleted flag if is set


    public
                    applyMarksDeleted() : self

Return values

self

changeCopiedName()

Set if change copied name is necessary


    public
                    changeCopiedName(bool $changeCopiedName) : self

Parameters

$changeCopiedName : bool: mode

Return values

self

changed()

Check model has been changed.


    public
                    changed() : bool

Return values

bool

check()

Check model values. If model has incorrect value, one will correct or call exception.


    public
                    check([bool $exception = FALSE ]) : self


$object = Core_ORM::factory('Book', 1);
$object->value = 123;
$object->check(TRUE)->save();

Parameters

$exception : bool = FALSE: Call exception (TRUE) or correct value (FALSE). Default FALSE.

Return values

self

chunk()

Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE


    public
                    chunk(int $count, callable $callback[, bool $bCache = TRUE ]) : bool

Parameters

$count : int: chunk size
$callback : callable
$bCache : bool = TRUE: use cache

Return values

bool

clear()

Clear object


    public
                    clear() : self

Return values

self

clearEntities()

Clear enities


    public
                    clearEntities() : self

Return values

self

clearEntitiesAfterGetXml()

Clear all entities after XML generation


    public
                    clearEntitiesAfterGetXml([bool $clear = TRUE ]) : self

Parameters

$clear : bool = TRUE: mode

Return values

self

clearXmlTags()

Clear external XML tags for entity.


    public
                    clearXmlTags() : mixed

copy()

Copy object


    public
                    copy() : new

Return values

new —

copied object

create()

Insert new object data into database


    public
                    create() : self

Return values

self

delete()

Delete object from database


    public
                    delete([mixed $primaryKey = NULL ]) : self

Parameters

$primaryKey : mixed = NULL: primary key for deleting object

Return values

self

deleteAll()

Delete all object


    public
                    deleteAll([bool $bCache = TRUE ][, int $limit = 100 ]) : self

Parameters

$bCache : bool = TRUE: use cache
$limit : int = 100: default 100 Core_ORM::factory('Book')->Comments->deleteAll();

Return values

self

factory()

Create and return an object of model


    public
            static        factory(string $modelName[, mixed $primaryKey = NULL ]) : mixed

Parameters

$modelName : string: Entity name
$primaryKey : mixed = NULL: Primary key

find()

Find object in database and load one


    public
                    find([mixed $primaryKey = NULL ][, bool $bCache = TRUE ]) : self

Parameters

$primaryKey : mixed = NULL: default NULL
$bCache : bool = TRUE: use cache

Return values

self

findAll()

Find all objects


    public
                    findAll([bool $bCache = TRUE ]) : array<string|int, mixed>

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

array<string|int, mixed>

getAllowedTags()

Get allowed tags list


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

Return values

array<string|int, mixed>

getChangedData()

Get changed columns with values


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

Return values

array<string|int, mixed>

getClassName()

Get Model CallsName


    public
            static        getClassName(mixed $modelName) : string

Parameters

$modelName : mixed: Model name

Return values

string

getCount()

Get count object


    public
                    getCount([bool $bCache = TRUE ][, string $fieldName = '*' ][, bool $distinct = FALSE ]) : int

Parameters

$bCache : bool = TRUE: use cache, default TRUE
$fieldName : string = '*': default '*'
$distinct : bool = FALSE: default FALSE

Return values

int

getDatabaseDriver()

Get name of Database Driver


    public
            static        getDatabaseDriver() : string

Return values

string

getDataValues()

Get dataValues


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

Return values

array<string|int, mixed>

getEntities()

Get children entities


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

Return values

array<string|int, mixed>

getFieldIDs()

Get visible field's IDs


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

Return values

array<string|int, mixed>

getFields()

Get field's values


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

Return values

array<string|int, mixed>

getFirst()

Get fist entity, ordered by primary key


    public
                    getFirst([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getFirst();
if (!is_null($mObject))
{
	echo $mObject;
}

getForbiddenTags()

Get forbidden tags list


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

Return values

array<string|int, mixed>

getLast()

Get last entity, ordered by primary key


    public
                    getLast([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getLast();
if (!is_null($mObject))
{
	echo $mObject;
}

getMarksDeleted()

Get column name for marks deleted


    public
                    getMarksDeleted() : string

Return values

string

getModelName()

Get model name, e.g. 'book' for 'Book_Model'


    public
                    getModelName() : string

Return values

string

getName()

Get entity name


    public
                    getName() : string

Return values

string

getNameColumn()

Get Name Column


    public
                    getNameColumn() : string

Return values

string

getPrimaryKey()

Get primary key value


    public
                    getPrimaryKey() : mixed

getPrimaryKeyName()

Get primary key name


    public
                    getPrimaryKeyName() : string

Return values

string

getRelatedSite()

Get Related Site


    public
                    getRelatedSite() : Site_Model|null

Return values

Site_Model|null

getRelations()

Get all relations of entity


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

Return values

array<string|int, mixed>

getStdObject()

Get stdObject for entity and children entities


    public
                    getStdObject([mixed $attributePrefix = '_' ]) : stdObject

Parameters

$attributePrefix : mixed = '_'

Return values

stdObject

getTableColumns()

Get tableColumns


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

Return values

array<string|int, mixed>

getTableColums()

Get table columns. Fix wrong method name


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

Return values

array<string|int, mixed>

getTableName()

Get table name


    public
                    getTableName() : string

Return values

string

getTrashDescription()

Get entity description


    public
                    getTrashDescription() : string

Return values

string

getXml()

Get XML for entity and children entities


    public
                    getXml() : string

Return values

string

getXmlTagName()

Get tag name


    public
                    getXmlTagName() : string

Return values

string

getXmlTags()

Get external XML tags for entity.


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

Return values

array<string|int, mixed>

isCallable()

Verify that the contents of a variable can be called as a function


    public
                    isCallable(string $methodName) : bool

Parameters

$methodName : string: method name

Return values

bool

isEmptyPrimaryKey()

Check is primary key NULL


    public
                    isEmptyPrimaryKey() : bool

Return values

bool

markDeleted()

Mark entity as deleted


    public
                    markDeleted() : self

Return values

self

queryBuilder()

Get query builder for select


    public
                    queryBuilder() : Core_QueryBuilder_Select

Return values

Core_QueryBuilder_Select

remove()

Remove related object. If main object does not save, it will save.


    public
                    remove(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

removeAllowedTag()

Remove tag from allowed tags list


    public
                    removeAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

removeForbiddenTag()

Remove tag from forbidden tags list


    public
                    removeForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

save()

Save object. Uses self::update() or self::create()


    public
                    save() : self

Return values

self

setCheck()

Set _check flag


    public
                    setCheck(bool $check) : self

Parameters

$check : bool: mode

Return values

self

setDatabaseDriver()

Set name of Database Driver


    public
            static        setDatabaseDriver(string $name) : mixed

Parameters

$name : string: driver's name

setMarksDeleted()

Set column name for marks deleted


    public
                    setMarksDeleted([mixed $marksDeleted = 'deleted' ]) : self

Parameters

$marksDeleted : mixed = 'deleted'

Return values

self

setRelations()

Set $this->_relations


    public
                    setRelations(array<string|int, mixed> $relations) : self

Parameters

$relations : array<string|int, mixed>: Array with new relations

Return values

self

setTableName()

Set table name


    public
                    setTableName(mixed $tableName) : selg

Parameters

$tableName : mixed

Return values

selg

setXmlTagName()

Set name of XML node


    public
                    setXmlTagName(string $tagName) : self

Parameters

$tagName : string: new tag name for node

Return values

self

toArray()

Convert Object to Array


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

Return values

array<string|int, mixed>

undelete()

Turn off deleted status


    public
                    undelete() : self

Return values

self

update()

Update object data into database


    public
                    update() : self

Return values

self

_getCopiedName()

Get the name of a new copied object


    protected
                    _getCopiedName() : mixed

_isTagAvailable()

Is $tagName Available


    protected
                    _isTagAvailable(mixed $tagName) : bool

Parameters

$tagName : mixed: Tag Name

Return values

bool

getDatabase()

Get Database


    protected
                    getDatabase() : Core_DataBase

Return values

Core_DataBase

Chartaccount_Entry_Subcount_Model extends Core_Entity in package HostCMS Chartaccount

Tags

Table of Contents

Properties

Methods

Properties

$config

$_allowedTags

$_attributes

$_belongsTo

$_changeCopiedName

$_changedColumns

$_dataValues

$_forbiddenTags

$_hasMany

$_hasOne

$_hasRevisions

$_marksDeleted

$_modelColumns

$_modelName

$_nameColumn

$_preloadValues

$_primaryKey

$_queryBuilder

$_shortcodeTags

$_skipColumns

$_sorting

$_tableColumns

$_tableName

$_typicalForbiddenTags

Methods

__call()

Parameters

__construct()

Parameters

add()

Parameters

Tags

Return values

addAllowedTag()

Parameters

Return values

addAllowedTags()

Parameters

Return values

addAttribute()

Parameters

Return values

addEntities()

Parameters

Return values

addEntity()

Parameters

Return values

addForbiddenTag()

Parameters

Return values

addForbiddenTags()

Parameters

Return values

addXmlTag()

Parameters

Return values

applyMarksDeleted()

Return values

changeCopiedName()

Parameters

Return values

changed()

Return values

check()

Parameters

Return values

chunk()

Parameters

Return values

clear()

Return values

clearEntities()

Return values

Chartaccount_Entry_Subcount_Model extends Core_Entity
in package

HostCMS

Chartaccount