Class cApiGroup

Group item

cGenericDb

Item

cApiGroup

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Located at classes/contenido/class.group.php

Methods summary
`public`	# `__construct( mixed $mId = false )` Constructor Function Constructor Function Parameters `$mId` `mixed` $mId Specifies the ID of item to load Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `Item::__construct()`
`public boolean`	# `loadGroupByGroupID( string $groupId )` Loads a group from the database by its groupId. Loads a group from the database by its groupId. Parameters `$groupId` `string` $groupId Specifies the groupId Returns `boolean` True if the load was successful
`public boolean`	# `loadGroupByGroupname( string $groupname )` Loads a group entry by its groupname. Loads a group entry by its groupname. Parameters `$groupname` `string` $groupname Specifies the groupname Returns `boolean` True if the load was successful
`public boolean`	# `setField( string $sField, string $mValue, boolean $bSafe = true )` User defined field value setter. User defined field value setter. Parameters `$sField` `string` $sField Field name `$mValue` `string` $mValue Value to set `$bSafe` `boolean` $bSafe Flag to run defined inFilter on passed value Returns `boolean` See `Item::setField()` Overrides `Item::setField()`
`public array`	# `getPermsArray( )` Returns list of group permissions. Returns list of group permissions. Returns `array`
`public Ambigous`	# `getGroupName( boolean $removePrefix = false )` Returns name of group. Returns name of group. Parameters `$removePrefix` `boolean` $removePrefix Flag to remove "grp_" prefix from group name Returns `Ambigous` <string, mixed, bool>
`public static string`	# `getUnprefixedGroupName( string $groupname )` Returns name of a group cleaned from prefix "grp_". Returns name of a group cleaned from prefix "grp_". Parameters `$groupname` `string` $groupname Returns `string`
`public static string`	# `prefixedGroupName( string $groupname )` Returns the passed groupname prefixed with "grp_", if not exists. Returns the passed groupname prefixed with "grp_", if not exists. Parameters `$groupname` `string` $groupname Returns `string`
`public string`	# `getGroupProperty( string $type, string $name )` Returns group property by its type and name Returns group property by its type and name Parameters `$type` `string` $type `$name` `string` $name Returns `string` bool value or false
`public array`	# `getGroupProperties( )` Retrieves all available properties of the group. Retrieves all available properties of the group. Returns `array` Returns assoziative properties array as follows: - $arr[idgroupprop][name] - $arr[idgroupprop][type] - $arr[idgroupprop][value]
`public cApiGroupProperty`	# `setGroupProperty( string $type, string $name, string $value )` Stores a property to the database. Stores a property to the database. Parameters `$type` `string` $type Type (class, category etc) for the property to retrieve `$name` `string` $name Name of the property to retrieve `$value` `string` $value Value to insert Returns `cApiGroupProperty`
`public boolean`	# `deleteGroupProperty( string $type, string $name )` Deletes a group property from the table. Deletes a group property from the table. Parameters `$type` `string` $type Type (class, category etc) for the property to delete `$name` `string` $name Name of the property to delete Returns `boolean`

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _outFilter(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getField(), getMetaObject(), getProperty(), isLoaded(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), set(), setFilters(), setProperty(), store(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`_getPropertiesCollectionInstance(), _getSecondDBInstance(), escape()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants summary
`string`	`PREFIX`	`'grp_'`	# Prefix to be used for group names. Prefix to be used for group names.

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_oCache, $_settings, $db, $lasterror, $primaryKey, $properties, $secondDb, $table, $virgin`

Packages

Classes

Class cApiGroup

Parameters

Throws

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns