Documentation

Category
in package

Digital Asset Management Category

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

CLOUDREXX Development Team info@cloudrexx.com

subpackage

module_downloads

version
1.0.0

Table of Contents

Properties

$EOF  : mixed
$error_msg  : string
Contains the message if an error occurs
$arrLoadedCategories  : array<string|int, mixed>
Array which holds all loaded categories for later usage
$arrPermissionTypes  : mixed
$id  : int
ID of loaded category
$set_permissions_recursive  : mixed
$add_files_access_id  : mixed
$add_files_groups  : mixed
$add_files_protected  : mixed
$add_subcategories_access_id  : mixed
$add_subcategories_groups  : mixed
$add_subcategories_protected  : mixed
$arrAttributes  : mixed
$arrPermissionDependencies  : mixed
$deletable_by_owner  : mixed
$descriptions  : mixed
$downloads  : mixed
$downloads_count  : mixed
$filtered_search_count  : int
Contains the number of currently loaded categories
$image  : mixed
$is_active  : bool
Active status of category
$isFrontendMode  : mixed
$manage_files_access_id  : mixed
$manage_files_groups  : mixed
$manage_files_protected  : mixed
$manage_subcategories_access_id  : mixed
$manage_subcategories_groups  : mixed
$manage_subcategories_protected  : mixed
$modify_access_by_owner  : mixed
$names  : mixed
$order  : mixed
$owner_id  : mixed
$parent_id  : mixed
$permission_set  : mixed
$read_access_id  : mixed
$read_groups  : mixed
$read_protected  : mixed
$visibility  : mixed

Methods

__clone()  : mixed
__construct()  : mixed
check4Subcategory()  : mixed
Check if the category is a subcategory of a specific category
delete()  : bool
Delete the current loaded category
first()  : mixed
Load first category
getActiveStatus()  : mixed
getAddFilesAccessId()  : mixed
getAddSubcategoriesAccessId()  : mixed
getAssociatedDownloadIds()  : mixed
getAssociatedDownloadsCount()  : mixed
Get associated downloads count
getCategories()  : mixed
getCategory()  : mixed
getCategoryWidgetNames()  : array<string|int, mixed>
Return a list of all available category widgets
getDeletableByOwner()  : mixed
getDescription()  : mixed
getErrorMsg()  : mixed
getFilteredSearchCategoryCount()  : mixed
getId()  : mixed
getImage()  : mixed
getManageFilesAccessId()  : mixed
getManageSubcategoriesAccessId()  : mixed
getModifyAccessByOwner()  : mixed
getName()  : mixed
getOrder()  : mixed
getOwnerId()  : mixed
getParentId()  : mixed
getPermissions()  : mixed
getReadAccessId()  : mixed
getVisibility()  : mixed
hasSubcategories()  : mixed
hasToSetPermissionsRecursive()  : mixed
loadLocales()  : mixed
next()  : mixed
Load next category
reset()  : mixed
setActiveStatus()  : mixed
setDeletableByOwner()  : mixed
setDescriptions()  : mixed
setDownloads()  : mixed
setImage()  : mixed
setModifyAccessByOwner()  : mixed
setNames()  : mixed
setOrder()  : mixed
setOwner()  : mixed
setParentId()  : mixed
setPermissions()  : mixed
setPermissionsRecursive()  : mixed
setVisibility()  : mixed
store()  : bool
Store category
storeDownloadAssociations()  : mixed
updateDownloadOrder()  : mixed
clean()  : mixed
Clean category metadata
getFilteredCategoryIdList()  : mixed
getSubCategories()  : mixed
Returns all children of the given category.
load()  : unknown
Load category data
loadAssociatedDownloadsCount()  : mixed
Load associated downloads and get its count
loadCategories()  : mixed
loadDownloadAssociations()  : mixed
parseFilterConditions()  : array<string|int, mixed>
Parse filter conditions
parseSearchConditions()  : mixed
resolvePermissionDependencies()  : mixed
setSortedCategoryIdList()  : mixed
storeLocales()  : bool
Store locales
storePermissions()  : mixed
validateName()  : mixed

Properties

$error_msg

Contains the message if an error occurs

public string $error_msg = array()

$arrLoadedCategories

Array which holds all loaded categories for later usage

protected array<string|int, mixed> $arrLoadedCategories = array()
Tags
access

protected

$arrPermissionTypes

protected mixed $arrPermissionTypes = array('read', 'add_subcategories', 'manage_subcategories', 'add_files', 'manage_files')

$set_permissions_recursive

protected mixed $set_permissions_recursive

$add_subcategories_access_id

private mixed $add_subcategories_access_id

$add_subcategories_groups

private mixed $add_subcategories_groups

$add_subcategories_protected

private mixed $add_subcategories_protected

$arrAttributes

private mixed $arrAttributes = array('core' => array('id' => 'int', 'is_active' => 'int', 'parent_id' => 'int', 'visibility' => 'int', 'owner_id' => 'int', 'image' => 'string', 'order' => 'int', 'deletable_by_owner' => 'int', 'modify_access_by_owner' => 'int', 'read_access_id' => 'int', 'add_subcategories_access_id' => 'int', 'manage_subcategories_access_id' => 'int', 'add_files_access_id' => 'int', 'manage_files_access_id' => 'int'), 'locale' => array('name' => 'string', 'description' => 'string'))

$arrPermissionDependencies

private mixed $arrPermissionDependencies = array('read' => array('add_subcategories' => array('manage_subcategories' => null), 'add_files' => array('manage_files' => null)))

$filtered_search_count

Contains the number of currently loaded categories

private int $filtered_search_count = 0
Tags
access

private

$is_active

Active status of category

private bool $is_active
Tags
access

private

$manage_subcategories_access_id

private mixed $manage_subcategories_access_id

$manage_subcategories_groups

private mixed $manage_subcategories_groups

$manage_subcategories_protected

private mixed $manage_subcategories_protected

Methods

check4Subcategory()

Check if the category is a subcategory of a specific category

public check4Subcategory(mixed $categoryId) : mixed
Parameters
$categoryId : mixed

delete()

Delete the current loaded category

public delete([mixed $recursive = false ]) : bool
Parameters
$recursive : mixed = false
Return values
bool

getAddSubcategoriesAccessId()

public getAddSubcategoriesAccessId() : mixed

getAssociatedDownloadIds()

public getAssociatedDownloadIds() : mixed

getAssociatedDownloadsCount()

Get associated downloads count

public getAssociatedDownloadsCount([bool $listDownloadsOfCurrentLanguage = false ]) : mixed
Parameters
$listDownloadsOfCurrentLanguage : bool = false

If true get Downloads count of current language otherwise get Downloads count of all language

getCategories()

public static getCategories([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

getCategory()

public static getCategory(mixed $id) : mixed
Parameters
$id : mixed

getCategoryWidgetNames()

Return a list of all available category widgets

public static getCategoryWidgetNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of category widget names

getDescription()

public getDescription([mixed $langId = 0 ]) : mixed
Parameters
$langId : mixed = 0

getFilteredSearchCategoryCount()

public getFilteredSearchCategoryCount() : mixed

getManageFilesAccessId()

public getManageFilesAccessId() : mixed

getManageSubcategoriesAccessId()

public getManageSubcategoriesAccessId() : mixed

getModifyAccessByOwner()

public getModifyAccessByOwner() : mixed

getName()

public getName([mixed $langId = 0 ]) : mixed
Parameters
$langId : mixed = 0

hasSubcategories()

public hasSubcategories([mixed $parentId = 0 ]) : mixed
Parameters
$parentId : mixed = 0

hasToSetPermissionsRecursive()

public hasToSetPermissionsRecursive() : mixed

setActiveStatus()

public setActiveStatus(mixed $active) : mixed
Parameters
$active : mixed

setDeletableByOwner()

public setDeletableByOwner(mixed $deletable) : mixed
Parameters
$deletable : mixed

setDescriptions()

public setDescriptions(mixed $arrDescriptions) : mixed
Parameters
$arrDescriptions : mixed

setDownloads()

public setDownloads(mixed $arrDownloads) : mixed
Parameters
$arrDownloads : mixed

setImage()

public setImage(mixed $path) : mixed
Parameters
$path : mixed

setModifyAccessByOwner()

public setModifyAccessByOwner(mixed $modifyAccess) : mixed
Parameters
$modifyAccess : mixed

setNames()

public setNames(mixed $arrNames) : mixed
Parameters
$arrNames : mixed

setOrder()

public setOrder(mixed $orderNr) : mixed
Parameters
$orderNr : mixed

setOwner()

public setOwner(mixed $userId) : mixed
Parameters
$userId : mixed

setParentId()

public setParentId(mixed $parentId) : mixed
Parameters
$parentId : mixed

setPermissions()

public setPermissions(mixed $arrPermissions) : mixed
Parameters
$arrPermissions : mixed

setPermissionsRecursive()

public setPermissionsRecursive(mixed $recursive) : mixed
Parameters
$recursive : mixed

setVisibility()

public setVisibility(mixed $visibility) : mixed
Parameters
$visibility : mixed

store()

Store category

public store() : bool

This stores the metadata of the category to the database.

Tags
global

ADONewConnection

global

array

Return values
bool

storeDownloadAssociations()

public storeDownloadAssociations() : mixed

updateDownloadOrder()

public updateDownloadOrder(mixed $arrDownloadOrder) : mixed
Parameters
$arrDownloadOrder : mixed

clean()

Clean category metadata

private clean() : mixed

Reset all category metadata for a new category.

getFilteredCategoryIdList()

private getFilteredCategoryIdList([mixed $arrFilter = null ][, mixed $search = null ]) : mixed
Parameters
$arrFilter : mixed = null
$search : mixed = null

getSubCategories()

Returns all children of the given category.

private getSubCategories(int $parentId) : mixed
Parameters
$parentId : int
Tags
acces

private

load()

Load category data

private load(int $id) : unknown

Get meta data of category from database and put them into the analogous class variables.

Parameters
$id : int
Return values
unknown

loadAssociatedDownloadsCount()

Load associated downloads and get its count

private loadAssociatedDownloadsCount(bool $listDownloadsOfCurrentLanguage) : mixed
Parameters
$listDownloadsOfCurrentLanguage : bool

If true get Downloads count of current language otherwise get Downloads count of all language

loadCategories()

private loadCategories([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

loadDownloadAssociations()

private loadDownloadAssociations() : mixed

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

resolvePermissionDependencies()

private resolvePermissionDependencies(mixed $arrCategoryPermissions, mixed $arrPermissionDependencies[, mixed $parentPermission = null ][, mixed $protected = false ]) : mixed
Parameters
$arrCategoryPermissions : mixed
$arrPermissionDependencies : mixed
$parentPermission : mixed = null
$protected : mixed = false

setSortedCategoryIdList()

private setSortedCategoryIdList(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
global

ADONewConnection

Return values
bool —

TRUE on success, otherwise FALSE


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results