Class Structure_Model

Structure_Model

Core_ORM

Core_Entity

Structure_Model

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

Methods summary

`public`	# `__construct( integer $id = NULL )` Constructor. Constructor. Parameters `$id` entity ID Overrides `Core_Entity::__construct`
`public array`	# `getPropertyValues( boolean $bCache = TRUE )` Values of all properties of element Values of all properties of element Parameters `$bCache` cache mode Returns array Property_Value
`public Structure_Model`	# `createDir( )` Create directory for item Create directory for item Returns `Structure_Model`
`public string`	# `getStructureFilePath( )` Get structure's file path Get structure's file path Returns string
`public string\|null`	# `getStructureFile( )` Get structure content Get structure content Returns string\|null
`public`	# `saveStructureFile( string $content )` Specify structure content Specify structure content Parameters `$content` content
`public string`	# `getStructureConfigFilePath( )` Get structure's config file path Get structure's config file path Returns string
`public string`	# `getStructureConfigFile( )` Get structure config Get structure config Returns string
`public`	# `saveStructureConfigFile( string $content )` Specify structure config Specify structure config Parameters `$content` config
`public Core_Entity`	# `save( )` Save object. Save object. Returns `Core_Entity` Overrides `Core_ORM::save`
`public Structure_Model`	# `deleteConfigFile( )` Delete Structure Config File Delete Structure Config File Returns `Structure_Model`
`public Structure_Model`	# `deleteFile( )` Delete Structure File Delete Structure File Returns `Structure_Model`
`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` Hostcms-event structure.onBeforeRedeclaredDelete Overrides `Core_Entity::delete`
`public string`	# `nameBadge( Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller )` Backend badge Backend badge Parameters `$oAdmin_Form_Field` `$oAdmin_Form_Controller` Returns string
`public integer`	# `getChildCount( )` Get count of substructures all levels Get count of substructures all levels Returns integer
`public string`	# `pathBackend( )` Backend callback method Backend callback method Returns string
`public Structure_Model\|null`	# `getParent( )` Get parent comment Get parent comment Returns `Structure_Model`\|null
`public array`	# `getBySiteId( integer $site_id )` Get all nodes by site ID Get all nodes by site ID Parameters `$site_id` site ID Returns array
`public array`	# `getByStructureMenuId( integer $structure_menu_id )` Get all nodes by menu ID Get all nodes by menu ID Parameters `$structure_menu_id` menu ID Returns array
`public`	# `getByPathAndParentId( string $path, integer $parent_id )` Get active structure node by path and parent_id Get active structure node by path and parent_id Parameters `$path` `$parent_id` Returns
`public string`	# `getPath( )` Get path for files Get path for files Returns string Hostcms-event structure.onBeforeGetPath
`public string`	# `getDirHref( )` Get object directory href Get object directory href Returns string
`public string`	# `getDirPath( )` Get object directory path Get object directory path Returns string
`public Structure_Model`	# `changeStatus( )` Change status of activity for structure node Change status of activity for structure node Returns `Structure_Model`
`public string`	# `structure_menu_idBackend( $oAdmin_Form_Field, $oAdmin_Form_Controller )` Backend callback method Backend callback method Returns string
`public Structure_Model`	# `changeIndexing( )` Switch indexing mode Switch indexing mode Returns `Structure_Model`
`public Core_Entity`	# `copy( )` Copy object Copy object Returns `Core_Entity` Hostcms-event structure.onAfterRedeclaredCopy Overrides `Core_Entity::copy`
`public`	# `execute( )` Executes the business logic. Executes the business logic. Hostcms-event structure.onBeforeExecute structure.onAfterExecute
`public Structure_Model`	# `showXmlProperties( boolean $showXmlProperties = TRUE )` Show properties in XML Show properties in XML Parameters `$showXmlProperties` Returns `Structure_Model`
`public string`	# `getXml( )` Get XML for entity and children entities Get XML for entity and children entities Returns string Hostcms-event structure.onBeforeRedeclaredGetXml Overrides `Core_Entity::getXml`
`public stdObject`	# `getStdObject( $attributePrefix = '_' )` Get stdObject for entity and children entities Get stdObject for entity and children entities Returns stdObject Hostcms-event structure.onBeforeRedeclaredGetStdObject Overrides `Core_Entity::getStdObject`
`protected Structure_Model`	# `_prepareData( )` Prepare entity and children entities Prepare entity and children entities Returns `Structure_Model`
`public integer`	# `getSiteuserGroupId( )` Get the ID of the user group Get the ID of the user group Returns integer
`public Search_Page`	# `indexing( )` Search indexation Search indexation Returns Search_Page Hostcms-event structure.onBeforeIndexing structure.onAfterIndexing
`public Structure_Model`	# `setCorePageSeo( Core_Page $oCore_Page )` Set SEO info to page from structure node Set SEO info to page from structure node Parameters `$oCore_Page` page Returns `Structure_Model` Hostcms-event structure.onAfterSetCorePageSeo
`public object`	# `getRelatedObjectByType( )` Get related object by type Get related object by type Returns object Hostcms-event structure.onBeforeGetRelatedObjectByType structure.onAfterGetRelatedObjectByType
`public Core_Entity`	# `markDeleted( )` Mark entity as deleted Mark entity as deleted Returns `Core_Entity` Overrides `Core_Entity::markDeleted`
`public Structure_Model`	# `clearCache( )` Clear tagged cache Clear tagged cache Returns `Structure_Model`
`public Structure_Model`	# `checkDuplicatePath( )` Check and correct duplicate path Check and correct duplicate path Returns `Structure_Model`
`public Structure_Model`	# `backupRevision( )` Backup revision Backup revision Returns `Structure_Model`
`public Structure_Model`	# `rollbackRevision( integer $revision_id )` Rollback Revision Rollback Revision Parameters `$revision_id` Revision ID Returns `Structure_Model`
`public Site_Model\|null`	# `getRelatedSite( )` Get Related Site Get Related Site Returns `Site_Model`\|null Hostcms-event structure.onBeforeGetRelatedSite structure.onAfterGetRelatedSite Overrides `Core_Entity::getRelatedSite`
`public string`	# `typeBackend( Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller )` Backend badge Backend badge Parameters `$oAdmin_Form_Field` `$oAdmin_Form_Controller` Returns string

Methods inherited from Core_Entity

__call(), _getCopiedName(), addAllowedTag(), addEntities(), addEntity(), addForbiddenTag(), addForbiddenTags(), addXmlTag(), applyMarksDeleted(), changeCopiedName(), clear(), clearEntities(), clearEntitiesAfterGetXml(), clearXmlTags(), create(), factory(), find(), findAll(), getCount(), getEntities(), getFieldIDs(), getFields(), getForbiddenTags(), getMarksDeleted(), getName(), getNameColumn(), getRelations(), getTableColums(), getTrashDescription(), getXmlTagName(), getXmlTags(), removeForbiddenTag(), setCheck(), setMarksDeleted(), setXmlTagName(), undelete(), update()

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(), setDatabaseDriver(), setRelations(), setValues(), toArray()

Properties summary

`protected mixed`	`$_modelName` Model name Model name	# `'structure'`
`protected array`	`$_preloadValues` List of preloaded values List of preloaded values	# `array( 'parent_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, // Warning: Удалить после объединения 'data_template_id' => 0, 'show' => 1, 'url' => '' )`
`protected array`	`$_belongsTo` Belongs to relations Belongs to relations	# `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(), // Warning: Удалить 'data_template' => array() )`
`protected array`	`$_hasMany` One-to-many or many-to-many relations One-to-many or many-to-many relations	# `array( 'structure' => array('foreign_key' => 'parent_id') )`
`protected array`	`$_hasOne` One-to-one relations One-to-one relations	# `array( 'forum' => array() )`
`protected array`	`$_forbiddenTags` Forbidden tags. If list of tags is empty, all tags will show. Forbidden tags. If list of tags is empty, all tags will show.	# `array( 'deleted', 'user_id', 'options' )`
`protected boolean`	`$_hasRevisions` Has revisions Has revisions Param boolean	# `TRUE`
`protected array`	`$_propertyValues` Values of all properties of structure node Values of all properties of structure node	# `NULL`
`protected boolean`	`$_showXmlProperties` Show properties in XML Show properties in XML	# `FALSE`

Properties inherited from Core_Entity

$_allowedTags, $_cacheAllowedTags, $_cacheFieldIDs, $_cacheForbiddenTags, $_cacheShortcodeTags, $_changeCopiedName, $_check, $_childrenEntities, $_clearEntitiesAfterGetXml, $_marksDeleted, $_nameColumn, $_shortcodeTags, $_tagName, $_typicalForbiddenTags, $_xmlTags

Classes

Exceptions

Functions

Class Structure_Model

Methods summary

Parameters

Overrides

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Overrides

Returns

Returns

Parameters

Returns

Hostcms-event

Overrides

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Hostcms-event

Returns

Returns

Returns

Returns

Returns

Returns

Hostcms-event

Overrides

Hostcms-event

Parameters

Returns

Returns

Hostcms-event

Overrides

Returns

Hostcms-event

Overrides

Returns

Returns

Returns

Hostcms-event

Parameters

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Overrides

Returns

Returns

Returns

Parameters

Returns

Returns

Hostcms-event

Overrides

Parameters

Returns

Methods inherited from Core_Entity

Methods inherited from Core_ORM

Properties summary

Param

Properties inherited from Core_Entity