Documentation

Shop_Group_Model extends Core_Entity
in package

Shop_Group_Model

Tags
subpackage

Shop

version
7.x
author

Hostmake LLC

copyright

© 2005-2022 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$adminPrice  : int
Backend property
$adminRest  : int
Backend property
$config  : mixed
ORM config
$count  : int
Backend property
$discounts  : int
Backend property
$img  : int
Backend property
$key  : int
Backend property
$modifications  : int
Backend property
$related  : int
Backend property
$reviews  : int
Backend property
$rollback  : mixed
Backend property
$status  : int
Backend property
$type  : int
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 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
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 group
$_queryBuilder  : Core_QueryBuilder_Select
Select query builder
$_shortcodeTags  : array<string|int, mixed>
List of Shortcodes tags
$_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
__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
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
changeActive()  : self
Change status of activity for group
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.
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()  : Core_ORM
Insert new object data into database
createDir()  : self
Create directory for group
decCountGroups()  : mixed
Уменьшение на 1 количества подгрупп в группе и во всех родительских группах
decCountItems()  : mixed
Уменьшение на 1 количества элементов в группе и во всех родительских группах
delete()  : self
Delete object from database
deleteAll()  : self
Delete all object
deleteLargeImage()  : mixed
Delete group's large image
deleteSmallImage()  : self
Delete group's small image
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
getByParentId()  : array<string|int, mixed>
Get group by parent id
getByParentIdAndPath()  : Shop_Group|null
Get group by parent group id and path
getChangedData()  : array<string|int, mixed>
Get changed columns with values
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
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
getGroupChildrenId()  : array<string|int, mixed>
Get IDs of child groups
getGroupHref()  : string
Get group href
getGroupPath()  : string
Get group path
getLargeFileHref()  : string
Get the path to the large image href
getLargeFilePath()  : string
Get the path to the large image of group
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
getParent()  : Shop_Group_Model|null
Get parent
getPath()  : string
Get group path
getPrimaryKey()  : mixed
Get primary key value
getPrimaryKeyName()  : string
Get primary key name
getPropertyValues()  : array<string|int, mixed>
Values of all properties of element
getRelatedSite()  : Site_Model|null
Get Related Site
getRelations()  : array<string|int, mixed>
Get $this->_relations
getSiteuserGroupId()  : int
Get the ID of the user group
getSmallFileHref()  : string
Get the path to the small image href
getSmallFilePath()  : string
Get the path to the small image of group
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.
groupPathWithSeparator()  : string
Get group path with separator
imgBackend()  : string
Backend callback method
incCountGroups()  : mixed
Увеличение на 1 количества подгрупп в группе и во всех родительских группах
incCountItems()  : mixed
Увеличение на 1 количества элементов в группе и во всех родительских группах
index()  : self
Add group into search index
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
makePath()  : mixed
Make url path
markDeleted()  : Core_Entity
Mark entity as deleted
modifyCountGroups()  : self
Change count of groups on $int
modifyCountItems()  : self
Modify count of items in group
move()  : self
Move group to another
nameBackend()  : string
Backend callback method
propertyValue()  : string
Get property value for SEO-templates
queryBuilder()  : Core_QueryBuilder_Select
Get query builder for select
remove()  : self
Remove related object. If main object does not save, it will save.
removeForbiddenTag()  : self
Remove tag from forbidden tags list
rollbackRevision()  : self
Rollback Revision
save()  : Core_Entity
Save object.
saveLargeImageFile()  : self
Specify large image for group
saveSmallImageFile()  : self
Specify small image for group
setCheck()  : self
Set _check flag
setDatabaseDriver()  : mixed
Set name of Database Driver
setLargeImageSizes()  : self
Set large image sizes
setMarksDeleted()  : self
Set column name for marks deleted
setRelations()  : self
Set $this->_relations
setSmallImageSizes()  : self
Set small image sizes
setXmlTagName()  : self
Set name of XML node
shortcut()  : Shop_Group_Model|null
Create shortcut and move into group $group_id
showXmlProperties()  : self
Show properties in XML
toArray()  : array<string|int, mixed>
Convert Object to Array
undelete()  : self
Turn off deleted status
unindex()  : self
Remove group from search index
update()  : self
Update object data into database
_getCopiedName()  : mixed
Get the name of a new copied object
_prepareData()  : self
Prepare entity and children entities
_preparePropertyValue()  : mixed
Prepare Property Value
getDatabase()  : Core_DataBase
Get Database

Properties

$adminPrice

Backend property

public int $adminPrice = \NULL

$adminRest

Backend property

public int $adminRest = \NULL

$config

ORM config

public static mixed $config = \NULL

$count

Backend property

public int $count = \NULL

$discounts

Backend property

public int $discounts = \NULL

$img

Backend property

public int $img = 0

$key

Backend property

public int $key = \NULL

$modifications

Backend property

public int $modifications = \NULL

Backend property

public int $related = \NULL

$reviews

Backend property

public int $reviews = \NULL

$rollback

Backend property

public mixed $rollback = 0

$status

Backend property

public int $status = \NULL

$type

Backend property

public int $type = \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('shop_group' => array('foreign_key' => 'parent_id'), 'shortcut' => array('model' => 'Shop_Group', 'foreign_key' => 'shortcut_id'), 'shop' => array(), 'siteuser_group' => array(), 'siteuser' => array(), 'user' => 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', 'seo_group_title_template', 'seo_group_keywords_template', 'seo_group_description_template', 'seo_item_title_template', 'seo_item_keywords_template', 'seo_item_description_template')

$_hasMany

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

protected array<string|int, mixed> $_hasMany = array('shop_group' => array('foreign_key' => 'parent_id'), 'shop_item' => array(), 'shop_item_property_for_group' => array(), 'shortcut' => array('model' => 'Shop_Group', 'foreign_key' => 'shortcut_id'), 'shop_filter_seo' => array(), 'shop_tab' => array('through' => 'shop_tab_group'), 'shop_tab_group' => array())

$_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 = \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 = 'shop_group'

$_nameColumn

Column consist item's name

protected string $_nameColumn = 'name'

$_preloadValues

List of preloaded values

protected array<string|int, mixed> $_preloadValues = array('shortcut_id' => 0, 'sorting' => 0, 'active' => 1, 'indexing' => 1)

$_primaryKey

Primary key

protected string $_primaryKey = 'id'

$_propertyValues

Values of all properties of group

protected array<string|int, mixed> $_propertyValues = \NULL

$_shortcodeTags

List of Shortcodes tags

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

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

Return values
mixed

__construct()

Constructor.

public __construct([int $id = NULL ]) : mixed
Parameters
$id : int = NULL

entity ID

Return values
mixed

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
hostcms-event

modelname.onBeforeAdd

hostcms-event

modelname.onAfterAdd

$object = Core_ORM::factory('Main', 1);

$child = Core_ORM::factory('Child') $child->value1 = 'some value1'; $child->value2 = 'some value2';

$object->add($child);

Return values
self

addAllowedTag()

Add tag to allowed tags list

public addAllowedTag(string $tag) : self
Parameters
$tag : string

tag

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

backupRevision()

Backup revision

public backupRevision() : self
Return values
self

changeActive()

Change status of activity for group

public changeActive() : self
Tags
hostcms-event

shop_group.onBeforeChangeActive

hostcms-event

shop_group.onAfterChangeActive

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

checkDuplicatePath()

Check and correct duplicate path

public checkDuplicatePath() : self
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

clearCache()

Clear tagged cache

public clearCache() : 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
Return values
mixed

createDir()

Create directory for group

public createDir() : self
Return values
self

decCountGroups()

Уменьшение на 1 количества подгрупп в группе и во всех родительских группах

public decCountGroups() : mixed
Return values
mixed

decCountItems()

Уменьшение на 1 количества элементов в группе и во всех родительских группах

public decCountItems() : mixed
Return values
mixed

delete()

Delete object from database

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

primary key for deleting object

Tags
hostcms-event

shop_group.onBeforeRedeclaredDelete

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

deleteLargeImage()

Delete group's large image

public deleteLargeImage() : mixed
Return values
mixed

deleteSmallImage()

Delete group's small image

public deleteSmallImage() : self
Return values
self

factory()

Create and return an object of model

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

Model name

$primaryKey : = NULL

Primary key

Return values
mixed

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
self

findAll()

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
hostcms-event

modelname.onBeforeFindAll

hostcms-event

modelname.onAfterFindAll

Return values
array<string|int, mixed>

getByParentId()

Get group by parent id

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

parent id

$bCache : bool = TRUE

cache mode

Return values
array<string|int, mixed>

getByParentIdAndPath()

Get group by parent group id and path

public getByParentIdAndPath(int $parent_id, string $path) : Shop_Group|null
Parameters
$parent_id : int

parent group id

$path : string

path

Return values
Shop_Group|null

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( $modelName) : string
Parameters
$modelName :

Model name

Return values
string

getCount()

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

getGroupChildrenId()

Get IDs of child groups

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

cache mode

Return values
array<string|int, mixed>
// Дочерние группы $shop_group_id магазина 1 $shop_group_id = 777; $oShop_Groups = Core_Entity::factory('Shop', $shop_id)->Shop_Groups; $oShop_Groups->queryBuilder() ->where('parent_id', '=', $shop_group_id);

$aChildrenId = $oShop_Groups->getGroupChildrenId(FALSE); foreach ($aChildrenId as $iGroupId) { var_dump($iGroupId); }

getGroupHref()

Get group href

public getGroupHref() : string
Return values
string

getGroupPath()

Get group path

public getGroupPath() : string
Return values
string

getLargeFileHref()

Get the path to the large image href

public getLargeFileHref() : string
Return values
string

getLargeFilePath()

Get the path to the large image of group

public getLargeFilePath() : string
Return values
string

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
Tags
hostcms-event

modelname.onBeforeGetName

Return values
string

getNameColumn()

Get Name Column

public getNameColumn() : string
Return values
string

getPath()

Get group path

public getPath() : string
Tags
hostcms-event

shop_group.onBeforeGetPath

Return values
string

getPrimaryKey()

Get primary key value

public getPrimaryKey() : mixed
Return values
mixed

getPrimaryKeyName()

Get primary key name

public getPrimaryKeyName() : string
Return values
string

getPropertyValues()

Values of all properties of element

public getPropertyValues([bool $bCache = TRUE ][, array<string|int, mixed> $aPropertiesId = array() ][, bool $bSorting = FALSE ]) : array<string|int, mixed>
Parameters
$bCache : bool = TRUE

cache mode

$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

getRelatedSite()

Get Related Site

public getRelatedSite() : Site_Model|null
Tags
hostcms-event

shop_group.onBeforeGetRelatedSite

hostcms-event

shop_group.onAfterGetRelatedSite

Return values
Site_Model|null

getRelations()

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
int

getSmallFileHref()

Get the path to the small image href

public getSmallFileHref() : string
Return values
string

getSmallFilePath()

Get the path to the small image of group

public getSmallFilePath() : string
Return values
string

getStdObject()

Get stdObject for entity and children entities

public getStdObject([mixed $attributePrefix = '_' ]) : stdObject
Parameters
$attributePrefix : mixed = '_'
Tags
hostcms-event

shop_group.onBeforeRedeclaredGetStdObject

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
Tags
hostcms-event

modelname.onBeforeGetTrashDescription

Return values
string

getXml()

Get XML for entity and children entities

public getXml() : string
Tags
hostcms-event

shop_group.onBeforeRedeclaredGetXml

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>

groupPathWithSeparator()

Get group path with separator

public groupPathWithSeparator([mixed $separator = ' → ' ], mixed $offset) : string
Parameters
$separator : mixed = ' → '
$offset : mixed
Return values
string

imgBackend()

Backend callback method

public imgBackend() : string
Return values
string

incCountGroups()

Увеличение на 1 количества подгрупп в группе и во всех родительских группах

public incCountGroups() : mixed
Return values
mixed

incCountItems()

Увеличение на 1 количества элементов в группе и во всех родительских группах

public incCountItems() : mixed
Return values
mixed

index()

Add group into search index

public index() : self
Return values
self

indexing()

Search indexation

public indexing() : Search_Page
Tags
hostcms-event

shop_group.onBeforeIndexing

hostcms-event

shop_group.onAfterIndexing

Return values
Search_Page

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

makePath()

Make url path

public makePath() : mixed
Return values
mixed

modifyCountGroups()

Change count of groups on $int

public modifyCountGroups([int $int = 1 ]) : self
Parameters
$int : int = 1
Return values
self

modifyCountItems()

Modify count of items in group

public modifyCountItems([int $int = 1 ][, bool $self = TRUE ]) : self
Parameters
$int : int = 1

value

$self : bool = TRUE

change items_count

Return values
self

move()

Move group to another

public move(int $parent_id) : self
Parameters
$parent_id : int

group id

Tags
hostcms-event

shop_group.onBeforeMove

hostcms-event

shop_group.onAfterMove

Return values
self

nameBackend()

Backend callback method

public nameBackend(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
string

propertyValue()

Get property value for SEO-templates

public propertyValue(int $property_id[, strint $format = '%2$s' ][, string $separator = ', ' ]) : string
Parameters
$property_id : int

Property ID

$format : strint = '%2$s'

string format, e.g. '%s: %s'. %1$s - Property Name, %2$s - List of Values

$separator : string = ', '

separator

Return values
string

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
Tags
hostcms-event

modelname.onBeforeRemove

hostcms-event

modelname.onAfterRemove

Return values
self

removeForbiddenTag()

Remove tag from forbidden tags list

public removeForbiddenTag(string $tag) : self
Parameters
$tag : string

tag

Return values
self

rollbackRevision()

Rollback Revision

public rollbackRevision(int $revision_id) : self
Parameters
$revision_id : int

Revision ID

Return values
self

saveLargeImageFile()

Specify large image for group

public saveLargeImageFile(string $fileSourcePath, string $fileName) : self
Parameters
$fileSourcePath : string

source file

$fileName : string

target file name

Return values
self

saveSmallImageFile()

Specify small image for group

public saveSmallImageFile(string $fileSourcePath, string $fileName) : self
Parameters
$fileSourcePath : string

source file

$fileName : string

target file name

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

Return values
mixed

setLargeImageSizes()

Set large image sizes

public setLargeImageSizes() : self
Return values
self

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

setSmallImageSizes()

Set small image sizes

public setSmallImageSizes() : self
Return values
self

setXmlTagName()

Set name of XML node

public setXmlTagName(string $tagName) : self
Parameters
$tagName : string

new tag name for node

Return values
self

shortcut()

Create shortcut and move into group $group_id

public shortcut([int $group_id = NULL ]) : Shop_Group_Model|null
Parameters
$group_id : int = NULL

group id

Return values
Shop_Group_Model|null

showXmlProperties()

Show properties in XML

public showXmlProperties([mixed $showXmlProperties = TRUE ][, mixed $xmlSortPropertiesValues = TRUE ]) : self
Parameters
$showXmlProperties : mixed = TRUE

array of allowed properties ID or boolean

$xmlSortPropertiesValues : mixed = TRUE
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
Tags
hostcms-event

modelname.onBeforeUndelete

hostcms-event

modelname.onAfterUndelete

Return values
self

unindex()

Remove group from search index

public unindex() : self
Return values
self

update()

Update object data into database

public update() : self
Tags
hostcms-event

modelname.onBeforeUpdate

hostcms-event

modelname.onAfterUpdate

Return values
self

_getCopiedName()

Get the name of a new copied object

protected _getCopiedName() : mixed
Return values
mixed

_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
Return values
mixed

Search results