Component Base Class

An interface for creating, retrieving, updating and deleting entities.

Class Methods

The following methods can be invoked on instances of this class.

componentIsInstalled()

Determines if a specific component is installed

componentGetEntityType(mixed arrEntity)

Returns the type of entity handled by the component

componentGetEntityIcon()

Retrieves the default icon path for the component entities

componentGetFeature()

Returns the feature the current component belongs to

install()

Installs the component

uninstall()

Uninstalls the component

eventGetHandlers()

Returns a set of event handlers for this component

eventTrigger(mixed strEvent, array arrEventParams)

Triggers a component event

securityOperationsGetAll()

Returns a set of security operations for this component

configGetAll(array arrProperties)

Retrieves all config items for the component

configGetAllValues(array arrProperties)

Retrieves all config items for the component in a item_id => item_value fashion

configGetValue(string strConfigId)

Retrieves the value of a config item for the current component

configSaveValue(mixed strConfigId, mixed strValue, string strReason)

Saves the value of a config item for the current component

uiGetActions(mixed bInList, bool bInEdit)

Returns an array of user interface actions for the component

__call(mixed strName, array arrArguments)

Magic function to trap calls to undefined functions and throw an exception rather than
a fatal error.

__callStatic(mixed strName, array arrArguments)

Magic function to trap static calls to undefined functions and throw an exception rather
than a fatal error.

classGetFolder()

Returns the folder where the class exists

__set_state(mixed arrValues)

classGetFolderResources()

Returns the folder where the class's resources exist

classGetSrcFile()

Returns the folder where the class exists

classGetSrcHash()

Returns the folder where the class exists

classGetReflection()

Returns the reflection data for the current class

classGetReflectionAnnotation(string strField)

Returns a specific class annotation for the current class