Group
in package
Digital Asset Management Category
Tags
Table of Contents
Properties
- $EOF : mixed
- $error_msg : string
- Contains the message if an error occurs
- $arrLoadedGroups : array<string|int, mixed>
- Array which holds all loaded groups for later usage
- $id : int
- ID of loaded group
- $arrAttributes : mixed
- $arrTypes : mixed
- $categories : mixed
- $categories_count : mixed
- $defaultType : mixed
- $filtered_search_count : int
- Contains the number of currently loaded groups
- $info_page : mixed
- $is_active : bool
- Active status of group
- $isFrontendMode : mixed
- $names : mixed
- $placeholder : mixed
- $source : mixed
- $type : mixed
Methods
- __clone() : mixed
- __construct() : mixed
- delete() : bool
- Delete the current loaded group
- first() : mixed
- Load first group
- getActiveStatus() : mixed
- getAssociatedCategoriesCount() : mixed
- getAssociatedCategoryIds() : mixed
- getErrorMsg() : mixed
- getFilteredSearchGroupCount() : mixed
- getGroup() : mixed
- getGroups() : mixed
- getGroupsPlaceholders() : array<string|int, mixed>
- Get Groups placeholders
- getId() : mixed
- getInfoPage() : mixed
- getName() : mixed
- getPlaceholder() : mixed
- getType() : mixed
- loadLocales() : mixed
- next() : mixed
- Load next group
- reset() : mixed
- setActiveStatus() : mixed
- setCategories() : mixed
- setInfoPage() : mixed
- setNames() : mixed
- setType() : mixed
- store() : bool
- Store group
- storeCategoryAssociations() : mixed
- clean() : mixed
- Clean group metadata
- getFilteredGroupIdList() : mixed
- load() : unknown
- Load group data
- loadAssociatedCategoriesCount() : mixed
- loadCategoryAssociations() : mixed
- loadGroups() : mixed
- parseFilterConditions() : array<string|int, mixed>
- Parse filter conditions
- parseSearchConditions() : mixed
- setSortedGroupIdList() : mixed
- storeLocales() : bool
- Store locales
- validateName() : mixed
Properties
$EOF
public
mixed
$EOF
Tags
$error_msg
Contains the message if an error occurs
public
string
$error_msg
= array()
$arrLoadedGroups
Array which holds all loaded groups for later usage
protected
array<string|int, mixed>
$arrLoadedGroups
= array()
Tags
$id
ID of loaded group
protected
int
$id
Tags
$arrAttributes
private
mixed
$arrAttributes
= array('core' => array('id' => 'int', 'is_active' => 'int', 'info_page' => 'string', 'type' => 'string'), 'locale' => array('name' => 'string'), 'category' => array('category_id' => 'int'))
$arrTypes
private
mixed
$arrTypes
= array('file', 'url')
$categories
private
mixed
$categories
$categories_count
private
mixed
$categories_count
$defaultType
private
mixed
$defaultType
= 'file'
$filtered_search_count
Contains the number of currently loaded groups
private
int
$filtered_search_count
= 0
Tags
$info_page
private
mixed
$info_page
$is_active
Active status of group
private
bool
$is_active
Tags
$isFrontendMode
private
mixed
$isFrontendMode
$names
private
mixed
$names
$placeholder
private
mixed
$placeholder
= 'DOWNLOADS_GROUP_%s'
$source
private
mixed
$source
$type
private
mixed
$type
Methods
__clone()
public
__clone() : mixed
__construct()
public
__construct() : mixed
delete()
Delete the current loaded group
public
delete() : bool
Return values
boolfirst()
Load first group
public
first() : mixed
getActiveStatus()
public
getActiveStatus() : mixed
getAssociatedCategoriesCount()
public
getAssociatedCategoriesCount() : mixed
getAssociatedCategoryIds()
public
getAssociatedCategoryIds() : mixed
getErrorMsg()
public
getErrorMsg() : mixed
getFilteredSearchGroupCount()
public
getFilteredSearchGroupCount() : mixed
getGroup()
public
static getGroup(mixed $id) : mixed
Parameters
- $id : mixed
getGroups()
public
static getGroups([mixed $filter = null ][, mixed $search = null ][, mixed $arrSort = null ][, mixed $arrAttributes = null ][, mixed $limit = null ][, mixed $offset = null ]) : mixed
Parameters
- $filter : mixed = null
- $search : mixed = null
- $arrSort : mixed = null
- $arrAttributes : mixed = null
- $limit : mixed = null
- $offset : mixed = null
getGroupsPlaceholders()
Get Groups placeholders
public
getGroupsPlaceholders() : array<string|int, mixed>
Return values
array<string|int, mixed>getId()
public
getId() : mixed
getInfoPage()
public
getInfoPage() : mixed
getName()
public
getName([mixed $langId = 0 ]) : mixed
Parameters
- $langId : mixed = 0
getPlaceholder()
public
getPlaceholder() : mixed
getType()
public
getType() : mixed
loadLocales()
public
loadLocales() : mixed
next()
Load next group
public
next() : mixed
reset()
public
reset() : mixed
setActiveStatus()
public
setActiveStatus(mixed $active) : mixed
Parameters
- $active : mixed
setCategories()
public
setCategories(mixed $arrCategories) : mixed
Parameters
- $arrCategories : mixed
setInfoPage()
public
setInfoPage(mixed $infoPage) : mixed
Parameters
- $infoPage : mixed
setNames()
public
setNames(mixed $arrNames) : mixed
Parameters
- $arrNames : mixed
setType()
public
setType(mixed $type) : mixed
Parameters
- $type : mixed
store()
Store group
public
store() : bool
This stores the metadata of the group to the database.
Tags
Return values
boolstoreCategoryAssociations()
public
storeCategoryAssociations() : mixed
clean()
Clean group metadata
private
clean() : mixed
Reset all group metadata for a new group.
getFilteredGroupIdList()
private
getFilteredGroupIdList([mixed $arrFilter = null ][, mixed $search = null ]) : mixed
Parameters
- $arrFilter : mixed = null
- $search : mixed = null
load()
Load group data
private
load(int $id) : unknown
Get meta data of group from database and put them into the analogous class variables.
Parameters
- $id : int
Return values
unknownloadAssociatedCategoriesCount()
private
loadAssociatedCategoriesCount() : mixed
loadCategoryAssociations()
private
loadCategoryAssociations() : mixed
loadGroups()
private
loadGroups([mixed $filter = null ][, mixed $search = null ][, mixed $arrSort = null ][, mixed $arrAttributes = null ][, mixed $limit = null ][, mixed $offset = null ]) : mixed
Parameters
- $filter : mixed = null
- $search : mixed = null
- $arrSort : mixed = null
- $arrAttributes : mixed = null
- $limit : mixed = null
- $offset : mixed = null
parseFilterConditions()
Parse filter conditions
private
parseFilterConditions(array<string|int, mixed> $arrFilter) : array<string|int, mixed>
Generate conditions of the attributes for the SQL WHERE statement. The filter conditions are defined through the two dimensional array $arrFilter. Each key-value pair represents an attribute and its associated condition to which it must fit to. The condition could either be a integer or string depending on the attributes type, or it could be a collection of integers or strings represented in an array.
Examples of the filer array:
array( 'name' => '%software%', ) // will return all categories who's name includes 'software'
array( 'name' => array( 'd%', 'e%', 'f%', 'g%' ) ) // will return all categories which have a name of which its first letter is and between 'd' to 'g' (case less)
array( 'name' => array( array( '>' => 'd', '<' => 'g' ), 'LIKE' => 'g%' ) ) // same as the preview example but in an other way
array( 'is_active' => 1, 'is_visibility' => 1 ) // will return all categories that are active and visible
Parameters
- $arrFilter : array<string|int, mixed>
Return values
array<string|int, mixed>parseSearchConditions()
private
parseSearchConditions(mixed $search) : mixed
Parameters
- $search : mixed
setSortedGroupIdList()
private
setSortedGroupIdList(mixed $arrSort[, mixed $sqlCondition = null ][, mixed $limit = null ][, mixed $offset = null ]) : mixed
Parameters
- $arrSort : mixed
- $sqlCondition : mixed = null
- $limit : mixed = null
- $offset : mixed = null
storeLocales()
Store locales
private
storeLocales() : bool
Tags
Return values
bool —TRUE on success, otherwise FALSE
validateName()
private
validateName() : mixed