contenido\classes\class.group.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: Contenido Group Management Modue

Requirements:

Author
Timo A. Hummel  
Con_php_req
5.0  
Copyright
four for business AG  
License
http://www.contenido.org/license/LIZENZ.txt  
Link
http://www.4fb.de  
Link
http://www.contenido.org  
Package
Contenido Backend classes  
Since
file available since contenido release <= 4.6 {@internal created 2003-05-20 modified 2008-07-02, Frederic Schneider, add security fix $Id: class.group.php 602 2008-07-11 13:12:28Z dominik.ziegler $: }}  
Version
1.6.1  

\Group
jump to top

Package: Default
Class Group Class for group information and management
Author
Timo A. Hummel  
Copyright
four for business 2003  
Version
1.0  

Properties

>VPropertypublicobject $db
DB_Contenido instance
Details
Type
object
Access
private  
>VPropertypublicarray $modifiedValues
Storage of the fields which were modified
Details
Type
array
Access
private  
>VPropertypublicstring $table
Storage of the source table to use for the group informations
Details
Type
string
Access
private  
>VPropertypublicarray $values
Storage of the source table to use for the group informations
Details
Type
array
Access
private  

Methods

methodpublicGroup(string $table = "") : void

Constructor Function

Parameters
NameTypeDescription
$tablestring

The table to use as information source

methodpublicdeleteGroupProperty(string $type, string $name) : void

deleteGroupProperty($type, $name) Deletes a group property from the table

Parameters
NameTypeDescription
$typestring

type Specifies the type (class, category etc) for the property to retrieve

$namestring

name Specifies the name of the property to retrieve

methodpublicgetField(string $field) : mixed

getField($field) Gets the value of a specific field

Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetGroupProperties() : void

getGroupProperties() Retrieves all available properties of the group

methodpublicgetGroupProperty(string $type, string $name) : string

getGroupProperty($type, $name) Stores the modified group object to the database

Parameters
NameTypeDescription
$typestring

type Specifies the type (class, category etc) for the property to retrieve

$namestring

name Specifies the name of the property to retrieve

Returns
TypeDescription
stringThe value of the retrieved property
methodpublicloadGroupByGroupID( $groupID) : bool

loadGroupByGroupID($groupID) Loads a group from the database by its groupID

Parameters
NameTypeDescription
$groupID
Returns
TypeDescription
boolTrue if the load was successful
methodpublicloadGroupByGroupname(string $groupname) : bool

loadGroupByGroupname($groupname) Loads a group from the database by its groupname

Parameters
NameTypeDescription
$groupnamestring

Specifies the groupname

Returns
TypeDescription
boolTrue if the load was successful
methodpublicsetField(string $field, string $value) : void

setField($field, $value) Sets the value of a specific field

Parameters
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

methodpublicsetGroupProperty(string $type, string $name, string $value) : void

setGroupProperty($type, $name, $value) Stores a property to the database

Parameters
NameTypeDescription
$typestring

type Specifies the type (class, category etc) for the property to retrieve

$namestring

name Specifies the name of the property to retrieve

$valuestring

value Specifies the value to insert

methodpublicstore() : void

store() Stores the modified group object to the database

\Groups
jump to top

Package: Default
Class Groups Container class for all system groups
Author
Timo A. Hummel  
Copyright
four for business AG 2003  
Version
1.0  

Properties

>VPropertypublicobject $db
DB_Contenido instance
Details
Type
object
Access
private  
>VPropertypublicstring $table
Storage of the source table to use for the group informations
Details
Type
string
Access
private  

Methods

methodpublicGroups(string $table = "") : void

Constructor Function

Parameters
NameTypeDescription
$tablestring

The table to use as information source

methodpublicdeleteGroupByGroupname( $groupname) : bool

deleteGroupByGroupname ($groupname) Removes the specified group from the database

Parameters
NameTypeDescription
$groupname
Returns
TypeDescription
boolTrue if the delete was successful
methodpublicdeleteGroupByID(string $groupid) : bool

deleteGroupByID ($groupid) Removes the specified group from the database

Parameters
NameTypeDescription
$groupidstring

Specifies the group ID

Returns
TypeDescription
boolTrue if the delete was successful
methodpublicgetAccessibleGroups( $perms) : array

getAccessibleGroups Returns all groups which are accessible by the current group

Parameters
NameTypeDescription
$perms
Returns
TypeDescription
arrayArray of group objects
Documentation was generated by phpDocumentor 2.0.0a12.