Structure_Model
extends Core_Entity
in package
Structure_Model
Tags
Table of Contents
Properties
- $config : mixed
- ORM config
- $data_template_id : null
- Backward compatibility
- $rollback : mixed
- Backend property
- $_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 show.
- $_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
- Marks deleted entity
- $_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
- $_primaryKey : string
- Primary key
- $_propertyValues : array<string|int, mixed>
- Values of all properties of structure node
- $_queryBuilder : Core_QueryBuilder_Select
- Select query builder
- $_shortcodeTags : array<string|int, mixed>
- List of Shortcodes tags
- $_showXmlMedia : bool
- Show media in XML
- $_showXmlProperties : bool
- Show properties in XML
- $_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.
- $_xmlSortPropertiesValues : mixed
- Sort properties values in XML
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
- backupRevision() : self
- Backup revision
- changeCopiedName() : self
- Set if change copied name is necessary
- changed() : bool
- Check model has been changed.
- changeIndexing() : self
- Switch indexing mode
- changeStatus() : self
- Change status of activity for structure node
- check() : self
- Check model values. If model has incorrect value, one will correct or call exception.
- checkBackendAccess() : bool
- Check user access to admin form action
- checkDuplicatePath() : self
- Check and correct duplicate path
- 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
- clearCache() : self
- Clear tagged cache
- clearEntities() : self
- Clear enities
- clearEntitiesAfterGetXml() : self
- Clear all entities after XML generation
- clearXmlTags() : mixed
- Clear external XML tags for entity.
- copy() : Core_Entity
- Copy object
- create() : self
- Insert new object data into database
- createDir() : self
- Create directory for item
- delete() : Core_Entity
- Delete object from database
- deleteAll() : self
- Delete all object
- deleteConfigFile() : self
- Delete Structure Config File
- deleteFile() : self
- Delete Structure File
- execute() : mixed
- Executes the business logic.
- factory() : mixed
- Create and return an object of model
- find() : self
- Find object in database and load one. Use clear() before find() with conditions!
- findAll() : array<string|int, mixed>
- Find all objects
- getAllowedTags() : array<string|int, mixed>
- Get allowed tags list
- getByPathAndParentId() : int|null
- Get active structure node by path and parent_id
- getBySiteId() : array<string|int, mixed>
- Get all nodes by site ID
- getByStructureMenuId() : array<string|int, mixed>
- Get all nodes by menu ID
- getChangedData() : array<string|int, mixed>
- Get changed columns with values
- getChildCount() : int
- Get count of substructures all levels
- getClassName() : string
- Get Model CallsName
- getCount() : int|false
- Get count object
- getDatabaseDriver() : string
- Get name of Database Driver
- getDataValues() : array<string|int, mixed>
- Get dataValues
- getDirHref() : string
- Get object directory href
- getDirPath() : string
- Get object directory path
- 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
- getLibFileHref() : string
- Get structure's lib file href
- getLibFilePath() : string
- Get structure's lib file path
- 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
- getParent() : Structure_Model|null
- Get parent comment
- getPath() : string
- Get path for files
- getPrimaryKey() : mixed
- Get primary key value
- getPrimaryKeyName() : string
- Get primary key name
- getPropertyValues() : array<string|int, mixed>
- Values of all properties of structure node Значения всех свойств узла структуры
- getRelatedObjectByType() : object
- Get related object by type
- getRelatedSite() : Site_Model|null
- Get Related Site
- getRelations() : array<string|int, mixed>
- Get $this->_relations
- getSiteuserGroupId() : int
- Get the ID of the user group
- getStdObject() : stdObject
- Get stdObject for entity and children entities
- getStructureConfigFile() : string
- Get structure config
- getStructureConfigFilePath() : string
- Get structure's config file path
- getStructureFile() : string|null
- Get structure content
- getStructureFilePath() : string
- Get structure's file path
- 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.
- indexing() : Search_Page
- Search indexation
- isCallable() : bool
- Verify that the contents of a variable can be called as a function
- isEmptyPrimaryKey() : bool
- Check is primary key NULL
- markDeleted() : Core_Entity
- Mark entity as deleted
- nameBackend() : string
- Backend callback method
- pathBackend() : string
- Backend callback method
- 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
- rollbackRevision() : self
- Rollback Revision
- save() : Core_Entity
- Save object.
- saveStructureConfigFile() : mixed
- Specify structure config
- saveStructureFile() : mixed
- Specify structure content
- setCheck() : self
- Set _check flag
- setCorePageSeo() : self
- Set SEO info to page from structure node
- setDatabaseDriver() : mixed
- Set name of Database Driver
- setMarksDeleted() : self
- Set column name for marks deleted
- setRelations() : self
- Set $this->_relations
- setXmlTagName() : self
- Set name of XML node
- shortcut() : Structure_Model
- Create shortcut and move into group $group_id
- showXmlMedia() : self
- Show properties in XML
- showXmlProperties() : self
- Show properties in XML
- structure_menu_idBackend() : string
- Backend callback method
- toArray() : array<string|int, mixed>
- Convert Object to Array
- typeBackend() : string
- Backend badge
- 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
- _prepareData() : self
- Prepare entity and children entities
- _preparePropertyValue() : mixed
- Prepare Property Value
- getDatabase() : Core_DataBase
- Get Database
Properties
$config
ORM config
public
static mixed
$config
= \NULL
$data_template_id
Backward compatibility
public
null
$data_template_id
= \NULL
$rollback
Backend property
public
mixed
$rollback
= 0
$_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(
'structure' => array('foreign_key' => 'parent_id'),
'structure_menu' => array(),
'template' => array(),
'document' => array(),
'lib' => array(),
'site' => array(),
'user' => array(),
'siteuser' => array(),
'siteuser_group' => array(),
'shortcut' => array('model' => 'Structure', 'foreign_key' => 'shortcut_id'),
// Warning: Удалить
'data_template' => 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 show.
protected
array<string|int, mixed>
$_forbiddenTags
= array('deleted', 'user_id', 'options')
$_hasMany
One-to-many or many-to-many relations
protected
array<string|int, mixed>
$_hasMany
= array('structure' => array('foreign_key' => 'parent_id'), 'shortcut' => array('model' => 'Structure', 'foreign_key' => 'shortcut_id'), 'media_structure' => array(), 'media_item' => array('through' => 'media_structure'))
$_hasOne
One-to-one relations
protected
array<string|int, mixed>
$_hasOne
= array('forum' => array())
$_hasRevisions
Has revisions
protected
mixed
$_hasRevisions
= \TRUE
$_marksDeleted
Marks deleted entity
protected
mixed
$_marksDeleted
= 'deleted'
$_modelColumns
List of columns in model with values
protected
array<string|int, mixed>
$_modelColumns
= array()
$_modelName
Model name
protected
mixed
$_modelName
= 'structure'
$_nameColumn
Column consist item's name
protected
string
$_nameColumn
= 'name'
$_preloadValues
List of preloaded values
protected
array<string|int, mixed>
$_preloadValues
= array('parent_id' => 0, 'shortcut_id' => 0, 'document_id' => 0, 'lib_id' => 0, 'type' => 0, 'sorting' => 0, 'https' => 0, 'active' => 1, 'indexing' => 1, 'changefreq' => 2, 'priority' => 0.5, 'siteuser_group_id' => 0, 'template_id' => 0, 'show' => 1, 'url' => '')
$_primaryKey
Primary key
protected
string
$_primaryKey
= 'id'
$_propertyValues
Values of all properties of structure node
protected
array<string|int, mixed>
$_propertyValues
= \NULL
$_queryBuilder
Select query builder
protected
Core_QueryBuilder_Select
$_queryBuilder
= \NULL
$_shortcodeTags
List of Shortcodes tags
protected
array<string|int, mixed>
$_shortcodeTags
= array()
$_showXmlMedia
Show media in XML
protected
bool
$_showXmlMedia
= \FALSE
$_showXmlProperties
Show properties in XML
protected
bool
$_showXmlProperties
= \FALSE
$_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()
$_xmlSortPropertiesValues
Sort properties values in XML
protected
mixed
$_xmlSortPropertiesValues
= \TRUE
Methods
__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([int $id = NULL ]) : mixed
Parameters
- $id : int = NULL
-
entity ID
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
Tags
Return values
selfaddAllowedTag()
Add tag to allowed tags list
public
addAllowedTag(string $tag) : self
Parameters
- $tag : string
-
tag
Return values
selfaddAllowedTags()
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
selfaddAttribute()
Add entity attribute
public
addAttribute(string $name, string $value) : self
Parameters
- $name : string
- $value : string
Return values
selfaddEntities()
Add children entities
public
addEntities(array<string|int, mixed> $aChildrenEntities) : self
Parameters
- $aChildrenEntities : array<string|int, mixed>
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 $tag) : self
Parameters
- $tag : string
-
tag
Return values
selfaddForbiddenTags()
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
selfaddXmlTag()
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
selfapplyMarksDeleted()
Apply markDeleted flag if is set
public
applyMarksDeleted() : self
Return values
selfbackupRevision()
Backup revision
public
backupRevision() : self
Return values
selfchangeCopiedName()
Set if change copied name is necessary
public
changeCopiedName(bool $changeCopiedName) : self
Parameters
- $changeCopiedName : bool
-
mode
Return values
selfchanged()
Check model has been changed.
public
changed() : bool
Return values
boolchangeIndexing()
Switch indexing mode
public
changeIndexing() : self
Return values
selfchangeStatus()
Change status of activity for structure node
public
changeStatus() : self
Tags
Return values
selfcheck()
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
selfcheckBackendAccess()
Check user access to admin form action
public
checkBackendAccess(string $actionName, User_Model $oUser) : bool
Parameters
- $actionName : string
-
admin form action name
- $oUser : User_Model
-
user object
Return values
boolcheckDuplicatePath()
Check and correct duplicate path
public
checkDuplicatePath() : self
Tags
Return values
selfchunk()
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
boolclear()
Clear object
public
clear() : self
Return values
selfclearCache()
Clear tagged cache
public
clearCache() : self
Return values
selfclearEntities()
Clear enities
public
clearEntities() : self
Return values
selfclearEntitiesAfterGetXml()
Clear all entities after XML generation
public
clearEntitiesAfterGetXml([bool $clear = TRUE ]) : self
Parameters
- $clear : bool = TRUE
-
mode
Return values
selfclearXmlTags()
Clear external XML tags for entity.
public
clearXmlTags() : mixed
copy()
Copy object
public
copy() : Core_Entity
Tags
Return values
Core_Entitycreate()
Insert new object data into database
public
create() : self
Tags
Return values
selfcreateDir()
Create directory for item
public
createDir() : self
Return values
selfdelete()
Delete object from database
public
delete([mixed $primaryKey = NULL ]) : Core_Entity
Parameters
- $primaryKey : mixed = NULL
-
primary key for deleting object
Tags
Return values
Core_EntitydeleteAll()
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
selfdeleteConfigFile()
Delete Structure Config File
public
deleteConfigFile() : self
Return values
selfdeleteFile()
Delete Structure File
public
deleteFile() : self
Return values
selfexecute()
Executes the business logic.
public
execute() : mixed
Tags
factory()
Create and return an object of model
public
static factory( $modelName[, $primaryKey = NULL ]) : mixed
Parameters
find()
Find object in database and load one. Use clear() before find() with conditions!
public
find([mixed $primaryKey = NULL ][, bool $bCache = TRUE ]) : self
Parameters
- $primaryKey : mixed = NULL
-
default NULL
- $bCache : bool = TRUE
-
use cache
// Find an object and load (without lazy load) // If an object is not found, primary key sets NULL $oBook = Core_ORM::factory('Book')->find(1);
Return values
selffindAll()
Find all objects
public
findAll([bool $bCache = TRUE ]) : array<string|int, mixed>
Parameters
- $bCache : bool = TRUE
-
use cache, default TRUE
// Find objects $aBooks = Core_ORM::factory('Book')->findAll(); foreach ($aBooks as $oBook) { var_dump($oBook->id); }
Tags
Return values
array<string|int, mixed>getAllowedTags()
Get allowed tags list
public
getAllowedTags() : array<string|int, mixed>
Return values
array<string|int, mixed>getByPathAndParentId()
Get active structure node by path and parent_id
public
getByPathAndParentId(string $path, int $parent_id) : int|null
Parameters
- $path : string
- $parent_id : int
Return values
int|nullgetBySiteId()
Get all nodes by site ID
public
getBySiteId(int $site_id) : array<string|int, mixed>
Parameters
- $site_id : int
-
site ID
Return values
array<string|int, mixed>getByStructureMenuId()
Get all nodes by menu ID
public
getByStructureMenuId(int $structure_menu_id) : array<string|int, mixed>
Parameters
- $structure_menu_id : int
-
menu ID
Return values
array<string|int, mixed>getChangedData()
Get changed columns with values
public
getChangedData() : array<string|int, mixed>
Return values
array<string|int, mixed>getChildCount()
Get count of substructures all levels
public
getChildCount() : int
Return values
intgetClassName()
Get Model CallsName
public
static getClassName( $modelName) : string
Parameters
Return values
stringgetCount()
Get count object
public
getCount([bool $bCache = TRUE ][, string $fieldName = '*' ][, bool $distinct = FALSE ]) : int|false
Parameters
- $bCache : bool = TRUE
-
use cache, default TRUE
- $fieldName : string = '*'
-
default '*'
- $distinct : bool = FALSE
-
default FALSE
Return values
int|false —
$iCount = Core_ORM::factory('Book')->getCount();
var_dump($iCount);
getDatabaseDriver()
Get name of Database Driver
public
static getDatabaseDriver() : string
Return values
stringgetDataValues()
Get dataValues
public
getDataValues() : array<string|int, mixed>
Return values
array<string|int, mixed>getDirHref()
Get object directory href
public
getDirHref() : string
Return values
stringgetDirPath()
Get object directory path
public
getDirPath() : string
Return values
stringgetEntities()
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;
}
getLibFileHref()
Get structure's lib file href
public
getLibFileHref() : string
Return values
stringgetLibFilePath()
Get structure's lib file path
public
getLibFilePath() : string
Return values
stringgetMarksDeleted()
Get column name for marks deleted
public
getMarksDeleted() : string
Return values
stringgetModelName()
Get model name, e.g. 'book' for 'Book_Model'
public
getModelName() : string
Return values
stringgetName()
Get entity name
public
getName() : string
Tags
Return values
stringgetNameColumn()
Get Name Column
public
getNameColumn() : string
Return values
stringgetParent()
Get parent comment
public
getParent() : Structure_Model|null
Return values
Structure_Model|nullgetPath()
Get path for files
public
getPath() : string
Tags
Return values
stringgetPrimaryKey()
Get primary key value
public
getPrimaryKey() : mixed
getPrimaryKeyName()
Get primary key name
public
getPrimaryKeyName() : string
Return values
stringgetPropertyValues()
Values of all properties of structure node Значения всех свойств узла структуры
public
getPropertyValues([bool $bCache = TRUE ][, array<string|int, mixed> $aPropertiesId = array() ][, bool $bSorting = FALSE ]) : array<string|int, mixed>
Parameters
- $bCache : bool = TRUE
-
cache mode status
- $aPropertiesId : array<string|int, mixed> = array()
-
array of properties' IDs
- $bSorting : bool = FALSE
-
sort results, default FALSE
Return values
array<string|int, mixed> —Property_Value
getRelatedObjectByType()
Get related object by type
public
getRelatedObjectByType() : object
Tags
Return values
objectgetRelatedSite()
Get Related Site
public
getRelatedSite() : Site_Model|null
Tags
Return values
Site_Model|nullgetRelations()
Get $this->_relations
public
getRelations() : array<string|int, mixed>
Return values
array<string|int, mixed>getSiteuserGroupId()
Get the ID of the user group
public
getSiteuserGroupId() : int
Return values
intgetStdObject()
Get stdObject for entity and children entities
public
getStdObject([mixed $attributePrefix = '_' ]) : stdObject
Parameters
- $attributePrefix : mixed = '_'
Tags
Return values
stdObjectgetStructureConfigFile()
Get structure config
public
getStructureConfigFile() : string
Return values
stringgetStructureConfigFilePath()
Get structure's config file path
public
getStructureConfigFilePath() : string
Return values
stringgetStructureFile()
Get structure content
public
getStructureFile() : string|null
Return values
string|nullgetStructureFilePath()
Get structure's file path
public
getStructureFilePath() : string
Return values
stringgetTableColumns()
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
stringgetTrashDescription()
Get entity description
public
getTrashDescription() : string
Tags
Return values
stringgetXml()
Get XML for entity and children entities
public
getXml() : string
Tags
Return values
stringgetXmlTagName()
Get tag name
public
getXmlTagName() : string
Return values
stringgetXmlTags()
Get external XML tags for entity.
public
getXmlTags() : array<string|int, mixed>
Return values
array<string|int, mixed>indexing()
Search indexation
public
indexing() : Search_Page
Tags
Return values
Search_PageisCallable()
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
boolisEmptyPrimaryKey()
Check is primary key NULL
public
isEmptyPrimaryKey() : bool
Return values
boolmarkDeleted()
Mark entity as deleted
public
markDeleted() : Core_Entity
Return values
Core_EntitynameBackend()
Backend callback method
public
nameBackend(mixed $oAdmin_Form_Field, mixed $oAdmin_Form_Controller) : string
Parameters
- $oAdmin_Form_Field : mixed
- $oAdmin_Form_Controller : mixed
Return values
stringpathBackend()
Backend callback method
public
pathBackend() : string
Return values
stringqueryBuilder()
Get query builder for select
public
queryBuilder() : Core_QueryBuilder_Select
Return values
Core_QueryBuilder_Selectremove()
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
Tags
Return values
selfremoveAllowedTag()
Remove tag from allowed tags list
public
removeAllowedTag(string $tag) : self
Parameters
- $tag : string
-
tag
Return values
selfremoveForbiddenTag()
Remove tag from forbidden tags list
public
removeForbiddenTag(string $tag) : self
Parameters
- $tag : string
-
tag
Return values
selfrollbackRevision()
Rollback Revision
public
rollbackRevision(int $revision_id) : self
Parameters
- $revision_id : int
-
Revision ID
Return values
selfsave()
Save object.
public
save() : Core_Entity
Return values
Core_EntitysaveStructureConfigFile()
Specify structure config
public
saveStructureConfigFile(string $content) : mixed
Parameters
- $content : string
-
config
saveStructureFile()
Specify structure content
public
saveStructureFile(string $content) : mixed
Parameters
- $content : string
-
content
setCheck()
Set _check flag
public
setCheck(bool $check) : self
Parameters
- $check : bool
-
mode
Return values
selfsetCorePageSeo()
Set SEO info to page from structure node
public
setCorePageSeo(Core_Page $oCore_Page) : self
Parameters
- $oCore_Page : Core_Page
-
page
Tags
Return values
selfsetDatabaseDriver()
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
selfsetRelations()
Set $this->_relations
public
setRelations(array<string|int, mixed> $relations) : self
Parameters
- $relations : array<string|int, mixed>
-
Array with new relations
Return values
selfsetXmlTagName()
Set name of XML node
public
setXmlTagName(string $tagName) : self
Parameters
- $tagName : string
-
new tag name for node
Return values
selfshortcut()
Create shortcut and move into group $group_id
public
shortcut([int $structure_id = NULL ]) : Structure_Model
Parameters
- $structure_id : int = NULL
-
group id
Return values
Structure_Model —Shortcut
showXmlMedia()
Show properties in XML
public
showXmlMedia([mixed $showXmlMedia = TRUE ]) : self
Parameters
- $showXmlMedia : mixed = TRUE
Return values
selfshowXmlProperties()
Show properties in XML
public
showXmlProperties([bool $showXmlProperties = TRUE ][, mixed $xmlSortPropertiesValues = TRUE ]) : self
Parameters
- $showXmlProperties : bool = TRUE
- $xmlSortPropertiesValues : mixed = TRUE
Return values
selfstructure_menu_idBackend()
Backend callback method
public
structure_menu_idBackend(mixed $oAdmin_Form_Field, mixed $oAdmin_Form_Controller) : string
Parameters
- $oAdmin_Form_Field : mixed
- $oAdmin_Form_Controller : mixed
Return values
stringtoArray()
Convert Object to Array
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>typeBackend()
Backend badge
public
typeBackend(Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller) : string
Parameters
- $oAdmin_Form_Field : Admin_Form_Field
- $oAdmin_Form_Controller : Admin_Form_Controller
Return values
stringundelete()
Turn off deleted status
public
undelete() : self
Tags
Return values
selfupdate()
Update object data into database
public
update() : self
Tags
Return values
self_getCopiedName()
Get the name of a new copied object
protected
_getCopiedName() : mixed
_isTagAvailable()
Is $tagName Available
protected
_isTagAvailable( $tagName) : bool
Parameters
Return values
bool_prepareData()
Prepare entity and children entities
protected
_prepareData() : self
Return values
self_preparePropertyValue()
Prepare Property Value
protected
_preparePropertyValue(Property_Value_Model $oProperty_Value) : mixed
Parameters
- $oProperty_Value : Property_Value_Model
getDatabase()
Get Database
protected
getDatabase() : Core_DataBase