CSHierarchy
in package
Tags
Table of Contents
- STATUS_UNKNOWN = -1
- getAllowedFolderObjectTypesForChildrenOfClassAndId() : array<string|int, mixed>
- Returns allowed folder objects types for children of specified class and id combination.
- getAllowedFolderObjectTypesForClassAndId() : array<string|int, mixed>
- Returns allowed folder objects types for specified class and id combination.
- getAllowedObjectTypesForChildrenOfClassAndId() : array<string|int, mixed>
- Returns allowed objects types for children of specified class and id combination.
- getAllowedObjectTypesForChildrenOfRecord() : array<string|int, mixed>
- Returns allowed objects types for children of specified record
- getAllowedObjectTypesForClassAndId() : array<string|int, mixed>
- Returns allowed objects types for specified class and id combination.
- getAllowedObjectTypesForRecord() : array<string|int, mixed>
- Returns allowed objects types for specified record
- getAllowedObjectTypeTemplatesForClassAndId() : array<string|int, mixed>
- Returns allowed object type templates for specified class and id.
- getAllowedObjectTypeTemplatesForRecord() : array<string|int, mixed>
- Returns allowed object type templates for specified record.
- getEffectiveObjectTypeTemplateIdForClassAndId() : int
- Returns the effective object type template id for the object specified by class and id.
- getEffectiveObjectTypeTemplateIdForRecord() : int
- Returns the effective object type template id for the specified record.
- getEffectiveParentObjectTypeTemplateIdForClassAndId() : int
- Returns the effective object type template id from parent for the object specified by class and id.
- getEffectiveParentObjectTypeTemplateIdForRecord() : int
- Returns the effective object type template id from parent for the specified record.
- getObjectTypes() : array<string|int, mixed>
- Returns all object types
- getObjectTypeTemplates() : array<string|int, mixed>
- Returns all object type templates
- isFolderObjectTypeForRecord() : bool
- Returns if the object type for the record is of folder type (has sub nodes)
- resetForClassAndId() : int
- Resets the object type to "unknown" for all children of the object specified by class and id.
- resetForDeletedTemplateId() : int
- Resets the object type and template for all objects bound to the object type template with the specified id.
- resetForRecord() : int
- Resets the object type to "unknown" for all children of the specified object
- resetForTemplateId() : int
- Resets the object type for all objects bound to the object type template with the specified id.
- updateClassIdsForObjectTypeIdAndRecord() : void
- Updates the provided item with configuration ids from the given object type
- updateConfigurationIdsForClassAndId() : void
- Updates the item after object type change
- updateConfigurationIdsForObjectTypeIdAndClass() : void
- Updates all items with new configuration id list
Constants
STATUS_UNKNOWN
public
mixed
STATUS_UNKNOWN
= -1
Tags
Methods
getAllowedFolderObjectTypesForChildrenOfClassAndId()
Returns allowed folder objects types for children of specified class and id combination.
public
static getAllowedFolderObjectTypesForChildrenOfClassAndId(string $sClass, int $iId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class of the object to get allowed folder object types of children.
- $iId : int
-
The id of the object to get allowed folder object types for children.
Tags
Return values
array<string|int, mixed> —Allowed folder object types of children for the specified record
getAllowedFolderObjectTypesForClassAndId()
Returns allowed folder objects types for specified class and id combination.
public
static getAllowedFolderObjectTypesForClassAndId(string $sClass, int $iId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class of the object to get allowed folder object types for.
- $iId : int
-
The id of the object to get allowed folder object types for.
Tags
Return values
array<string|int, mixed> —Allowed folder object types for the specified record
getAllowedObjectTypesForChildrenOfClassAndId()
Returns allowed objects types for children of specified class and id combination.
public
static getAllowedObjectTypesForChildrenOfClassAndId(string $sClass, int $iId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class of the object to get allowed object types of children.
- $iId : int
-
The id of the object to get allowed object types for children.
Tags
Return values
array<string|int, mixed> —Allowed object types of children for the specified record
getAllowedObjectTypesForChildrenOfRecord()
Returns allowed objects types for children of specified record
public
static getAllowedObjectTypesForChildrenOfRecord(Record $oRecord) : array<string|int, mixed>
Parameters
- $oRecord : Record
-
The record instance for which to check the allowed object types for children.
Tags
Return values
array<string|int, mixed> —Allowed object types of children for the specified record
getAllowedObjectTypesForClassAndId()
Returns allowed objects types for specified class and id combination.
public
static getAllowedObjectTypesForClassAndId(string $sClass, int $iId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class of the object to get allowed object types for.
- $iId : int
-
The id of the object to get allowed object types for.
Tags
Return values
array<string|int, mixed> —Allowed object types for the specified class and id
getAllowedObjectTypesForRecord()
Returns allowed objects types for specified record
public
static getAllowedObjectTypesForRecord(Record $oRecord) : array<string|int, mixed>
Parameters
- $oRecord : Record
-
The record instance for which to check the allowed object types.
Tags
Return values
array<string|int, mixed> —Allowed object types for the specified record
getAllowedObjectTypeTemplatesForClassAndId()
Returns allowed object type templates for specified class and id.
public
static getAllowedObjectTypeTemplatesForClassAndId(string $sClass, int $iId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class for which to get allowed object type templates.
- $iId : int
-
The id for which to get allowed object type templates.
Tags
Return values
array<string|int, mixed> —Allowed object type templates for specified class and id.
getAllowedObjectTypeTemplatesForRecord()
Returns allowed object type templates for specified record.
public
static getAllowedObjectTypeTemplatesForRecord(Record $oRecord) : array<string|int, mixed>
Parameters
- $oRecord : Record
-
The record instance for which to get allowed object type templates.
Tags
Return values
array<string|int, mixed> —Allowed object type templates for specified record.
getEffectiveObjectTypeTemplateIdForClassAndId()
Returns the effective object type template id for the object specified by class and id.
public
static getEffectiveObjectTypeTemplateIdForClassAndId(string $sClass, int $iId) : int
Parameters
- $sClass : string
-
The class of object to retrieve the effective object type template id.
- $iId : int
Tags
Return values
int —The effective object type template id if any
getEffectiveObjectTypeTemplateIdForRecord()
Returns the effective object type template id for the specified record.
public
static getEffectiveObjectTypeTemplateIdForRecord(TreeRecord $oRecord) : int
Parameters
- $oRecord : TreeRecord
-
The object for which to retrieve the effective object type template id.
Tags
Return values
int —The effective object type template id if any
getEffectiveParentObjectTypeTemplateIdForClassAndId()
Returns the effective object type template id from parent for the object specified by class and id.
public
static getEffectiveParentObjectTypeTemplateIdForClassAndId(string $sClass, int $iId) : int
Parameters
- $sClass : string
-
The class of object to retrieve the effective object type template id.
- $iId : int
Tags
Return values
int —The effective object type template id from parent if any
getEffectiveParentObjectTypeTemplateIdForRecord()
Returns the effective object type template id from parent for the specified record.
public
static getEffectiveParentObjectTypeTemplateIdForRecord(TreeRecord $oRecord) : int
Parameters
- $oRecord : TreeRecord
-
The object for which to retrieve the effective object type template id.
Tags
Return values
int —The effective object type template id from parent if any
getObjectTypes()
Returns all object types
public
static getObjectTypes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —A list of available object types as id=>label mapping
getObjectTypeTemplates()
Returns all object type templates
public
static getObjectTypeTemplates() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —A list of available object type templates as id=>label mapping
isFolderObjectTypeForRecord()
Returns if the object type for the record is of folder type (has sub nodes)
public
static isFolderObjectTypeForRecord(Record $oRecord) : bool
Parameters
- $oRecord : Record
-
New record being created/moved
Tags
Return values
bool —Returns true if object type has sub nodes or false if not
resetForClassAndId()
Resets the object type to "unknown" for all children of the object specified by class and id.
public
static resetForClassAndId(string $sClass, int $iId) : int
Parameters
- $sClass : string
-
The class of object to reset children's object type for.
- $iId : int
-
The id of object to reset children's object type for.
Tags
Return values
int —Number of resetted objects.
resetForDeletedTemplateId()
Resets the object type and template for all objects bound to the object type template with the specified id.
public
static resetForDeletedTemplateId(int $iTemplateId) : int
Parameters
- $iTemplateId : int
-
The template id for which to reset the objects.
Tags
Return values
int —Number of resetted objects.
resetForRecord()
Resets the object type to "unknown" for all children of the specified object
public
static resetForRecord(TreeRecord $oRecord) : int
Parameters
- $oRecord : TreeRecord
-
The record to reset children's object type for.
Tags
Return values
int —Number of resetted objects.
resetForTemplateId()
Resets the object type for all objects bound to the object type template with the specified id.
public
static resetForTemplateId(int $iTemplateId) : int
Parameters
- $iTemplateId : int
-
The template id for which to reset the object type.
Tags
Return values
int —Number of resetted objects.
updateClassIdsForObjectTypeIdAndRecord()
Updates the provided item with configuration ids from the given object type
public
static updateClassIdsForObjectTypeIdAndRecord(int $iObjectTypeId, Item $oItem) : void
Parameters
- $iObjectTypeId : int
-
The id of the object type
- $oItem : Item
-
The object for which ClassIDs need to be set
Tags
Return values
void —updateConfigurationIdsForClassAndId()
Updates the item after object type change
public
static updateConfigurationIdsForClassAndId(string $sClass, int $iId, array<string|int, mixed> $aConfigurationIdsToAdd) : void
Parameters
- $sClass : string
-
The class of the item to update.
- $iId : int
-
The id of the item to update.
- $aConfigurationIdsToAdd : array<string|int, mixed>
Tags
Return values
void —updateConfigurationIdsForObjectTypeIdAndClass()
Updates all items with new configuration id list
public
static updateConfigurationIdsForObjectTypeIdAndClass(int $iObjectTypeId, string $sClass, array<string|int, mixed> $aConfigurationIdsToAdd) : void
Parameters
- $iObjectTypeId : int
- $sClass : string
-
The class of the item to update.
- $aConfigurationIdsToAdd : array<string|int, mixed>
-
The configuration ids to set on that item