Class Core_Entity

Content management system entity

Implement methods like getByXXX($value, $cache = TRUE) where XXX is the field name

$object = Core_Entity::factory('Book')->getByName('The Catcher in the Rye');

Implement methods like getAllByXXX($value, $cache = TRUE) where XXX is the field name

$aObject = Core_Entity::factory('Book')->getAllByName('The Catcher in the Rye');

Core_ORM

Core_Entity

Direct known subclasses

Indirect known subclasses

Package: HostCMS\Core
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
See: Core_ORM
Located at core/entity.php

Methods summary

`public Core_Entity`	# `setXmlTagName( string $tagName )` Set name of XML node Set name of XML node Parameters `$tagName` new tag name for node Returns `Core_Entity`
`public string`	# `getXmlTagName( )` Get tag name Get tag name Returns string
`public Core_Entity`	# `addAllowedTag( string $tag )` Add tag to allowed tags list Add tag to allowed tags list Parameters `$tag` tag Returns `Core_Entity`
`public Core_Entity`	# `addForbiddenTag( string $tag )` Add tag to forbidden tags list Add tag to forbidden tags list Parameters `$tag` tag Returns `Core_Entity`
`public Core_Entity`	# `removeForbiddenTag( string $tag )` Remove tag from forbidden tags list Remove tag from forbidden tags list Parameters `$tag` tag Returns `Core_Entity`
`public Core_Entity`	# `addForbiddenTags( array $aTags )` Add tags to forbidden tags list Add tags to forbidden tags list Parameters `$aTags` array of tags Returns `Core_Entity`
`public array`	# `getForbiddenTags( )` Get forbidden tags list Get forbidden tags list Returns array
`public Core_Entity`	# `addXmlTag( string $tagName, string $tagValue )` Add external tag for entity Add external tag for entity Parameters `$tagName` tag name `$tagValue` tag value Returns `Core_Entity`
`public`	# `clearXmlTags( )` Clear external XML tags for entity. Clear external XML tags for entity.
`public array`	# `getXmlTags( )` Get external XML tags for entity. Get external XML tags for entity. Returns array
`public array`	# `getEntities( )` Get children entities Get children entities Returns array
`public Core_Entity`	# `clearEntities( )` Clear enities Clear enities Returns `Core_Entity`
`public`	# `getMarksDeleted( )` Get column name for marks deleted Get column name for marks deleted
`public`	# `setMarksDeleted( mixed $marksDeleted = 'deleted' )` Set column name for marks deleted Set column name for marks deleted Parameters `$marksDeleted`
`public`	# `__construct( string $primaryKey = NULL )` Constructor. Constructor. Parameters `$primaryKey` Overrides `Core_ORM::__construct`
`public static`	# `factory( string $modelName, mixed $primaryKey = NULL )` Create and return an object of model Create and return an object of model Parameters `$modelName` Entity name `$primaryKey` Primary key Overrides `Core_ORM::factory`
`public array`	# `getTableColums( )` Get table columns. Fix wrong method name Get table columns. Fix wrong method name Returns array
`public array`	# `getRelations( )` Get all relations of entity Get all relations of entity Returns array Overrides `Core_ORM::getRelations`
`public Core_Entity`	# `markDeleted( )` Mark entity as deleted Mark entity as deleted Returns `Core_Entity` Hostcms-event modelname.onBeforeMarkDeleted modelname.onAfterMarkDeleted
`public Core_Entity`	# `undelete( )` Turn off deleted status Turn off deleted status Returns `Core_Entity` Hostcms-event modelname.onBeforeUndelete modelname.onAfterUndelete
`public Core_Entity`	# `clear( )` Clear object Clear object Returns `Core_Entity` Overrides `Core_ORM::clear`
`public Core_Entity`	# `delete( mixed $primaryKey = NULL )` Delete object from database Delete object from database Parameters `$primaryKey` primary key for deleting object Returns `Core_Entity` Overrides `Core_ORM::delete`
`public Core_Entity`	# `applyMarksDeleted( )` Apply markDeleted flag if is set Apply markDeleted flag if is set Returns `Core_Entity`
`public Core_ORM`	# `find( mixed $primaryKey = NULL, boolean $bCache = TRUE )` Find object in database and load one Find object in database and load one Parameters `$primaryKey` default NULL `$bCache` use cache Returns `Core_ORM` Overrides `Core_ORM::find`
`public array`	# `findAll( boolean $bCache = TRUE )` Find all objects Find all objects Parameters `$bCache` use cache, default TRUE Returns array Overrides `Core_ORM::findAll`
`public integer`	# `getCount( boolean $bCache = TRUE, string $fieldName = '', boolean $distinct = FALSE )` Get count object Get count object Parameters `$bCache` use cache, default TRUE `$fieldName` default '' `$distinct` default FALSE Returns integer Overrides `Core_ORM::getCount`
`public`	# `addEntity( Core_Entity $oChildrenEntity )` Add a children entity Add a children entity Parameters `$oChildrenEntity`
`public`	# `addEntities( array $aChildrenEntities )` Add children entities Add children entities Parameters `$aChildrenEntities`
`public Core_Entity`	# `clearEntitiesAfterGetXml( boolean $clear = TRUE )` Clear all entities after XML generation Clear all entities after XML generation Parameters `$clear` mode Returns `Core_Entity`
`public array`	# `getFieldIDs( )` Get visible field's IDs Get visible field's IDs Returns array
`public array`	# `getFields( )` Get field's values Get field's values Returns array
`public string`	# `getXml( )` Get XML for entity and children entities Get XML for entity and children entities Returns string Hostcms-event modelname.onBeforeGetXml modelname.onAfterGetXml
`public stdObject`	# `getStdObject( $attributePrefix = '_' )` Get stdObject for entity and children entities Get stdObject for entity and children entities Returns stdObject Hostcms-event modelname.onBeforeGetArray modelname.onAfterGetArray
`public Core_Entity`	# `setCheck( boolean $check )` Set _check flag Set _check flag Parameters `$check` mode Returns `Core_Entity`
`public Core_ORM`	# `create( )` Insert new object data into database Insert new object data into database Returns `Core_ORM` Overrides `Core_ORM::create`
`public Core_ORM`	# `update( )` Update object data into database Update object data into database Returns `Core_ORM` Overrides `Core_ORM::update`
`public string`	# `getNameColumn( )` Get Name Column Get Name Column Returns string
`public string`	# `getName( )` Get entity name Get entity name Returns string Hostcms-event modelname.onBeforeGetName
`public string`	# `getTrashDescription( )` Get entity description Get entity description Returns string Hostcms-event modelname.onBeforeGetTrashDescription
`public Core_Entity`	# `changeCopiedName( boolean $changeCopiedName )` Set if change copied name is necessary Set if change copied name is necessary Parameters `$changeCopiedName` mode Returns `Core_Entity`
`protected`	# `_getCopiedName( )` Get the name of a new copied object Get the name of a new copied object
`public Core_Entity`	# `copy( )` Copy object Copy object Returns `Core_Entity` new copied object Hostcms-event modelname.onBeforeCopy modelname.onAfterCopy
`public Site_Model\|null`	# `getRelatedSite( )` Get Related Site Get Related Site Returns `Site_Model`\|null Hostcms-event modelname.onBeforeGetRelatedSite modelname.onAfterGetRelatedSite
`public mixed`	# `__call( string $name, array $arguments )` Triggered when invoking inaccessible methods in an object context Triggered when invoking inaccessible methods in an object context Parameters `$name` method name `$arguments` arguments Returns mixed Overrides `Core_ORM::__call`

Methods inherited from Core_ORM

__clone(), __get(), __isset(), __set(), __toString(), _convertPropertyValue(), _getRelation(), _init(), _load(), _loadColumnCacheDefaultValues(), _loadColumns(), _onAfterLoad(), _onBeforeLoad(), _relations(), _setDefaultValues(), _setPreloadValues(), add(), changed(), check(), chunk(), clearColumnCache(), clearRelationCache(), clearRelationModelCache(), deleteAll(), getChangedData(), getClassName(), getDatabase(), getFirst(), getLast(), getModelName(), getPrimaryKey(), getPrimaryKeyName(), getTableColumns(), getTableName(), isCallable(), isEmptyPrimaryKey(), load(), loaded(), queryBuilder(), remove(), save(), setDatabaseDriver(), setRelations(), setValues(), toArray()

Properties summary

`protected string`	`$_tagName` Name of the tag in XML Name of the tag in XML	# `NULL`
`protected array`	`$_allowedTags` Allowed tags. If list of tags is empty, all tags will show. Allowed tags. If list of tags is empty, all tags will show.	# `array()`
`protected array`	`$_shortcodeTags` List of Shortcodes tags List of Shortcodes tags	# `array()`
`protected array`	`$_typicalForbiddenTags` Typical forbidden tags. Typical forbidden tags.	# `array()`
`protected array`	`$_forbiddenTags` Forbidden tags. If list of tags is empty, all tags will be shown. Forbidden tags. If list of tags is empty, all tags will be shown.	# `array('deleted', 'user_id')`
`protected array`	`$_xmlTags` External XML tags for entity. External XML tags for entity.	# `array()`
`protected array`	`$_childrenEntities` Children entities Children entities	# `array()`
`protected string`	`$_marksDeleted` Marks deleted entity Marks deleted entity Param mixed Name of field with 'deleted' status. If NULL, marks deleted will not be allowed.	# `'deleted'`
`protected boolean`	`$_hasRevisions` Has revisions Has revisions Param boolean	# `FALSE`
`protected static array`	`$_cacheAllowedTags`	# `array()`
`protected static array`	`$_cacheForbiddenTags`	# `array()`
`protected static array`	`$_cacheShortcodeTags`	# `array()`
`protected boolean`	`$_clearEntitiesAfterGetXml` Clear all entities after XML generation Clear all entities after XML generation	# `TRUE`
`protected static array`	`$_cacheFieldIDs`	# `array()`
`protected boolean`	`$_check` Check model values. If model has incorrect value, one will correct or call exception. Check model values. If model has incorrect value, one will correct or call exception.	# `FALSE`
`protected string`	`$_nameColumn` Column consist item's name Column consist item's name	# `'name'`
`protected boolean`	`$_changeCopiedName` Change copied name is necessary, default FALSE Change copied name is necessary, default FALSE	# `FALSE`

Classes

Exceptions

Functions

Class Core_Entity

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Parameters

Overrides

Parameters

Overrides

Returns

Returns

Overrides

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Parameters

Parameters

Returns

Returns

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Parameters

Returns

Returns

Overrides

Returns

Overrides

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Parameters

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Parameters

Returns