Class: GALGroups

Source Location: /libgallue/group.inc.php

Class Overview

GALTable
   |
   --GALGallueTable
      |
      --GALGroups

Manage groups and handle database communication.

Inherited Variables

Class: GALTable

GALTable::$db
GALTable::$descriptor
GALTable::$primary
GALTable::$resultFactory
GALTable::$rowFactory
GALTable::$rows
GALTable::$tableName

Inherited Methods

Class: GALGallueTable

GALGallueTable::__construct(): Initializes $glb object variable.
GALGallueTable::search(): SQL expression that searches for items containing $term.
GALGallueTable::visible(): SQL expression that is TRUE only for items visible to the user currently logged in.
GALGallueTable::writeable(): SQL expression that is TRUE only for items writeable by the user currently logged in.

Class: GALTable

GALTable::__construct(): Initializes this table.
GALTable::buildResult(): Implements the GALResultFactory interface.
GALTable::compareExpression(): Factory for GALExpressionCompare objects.
GALTable::containsKeyFields(): Checks if the specified fields contains a field that belongs to the primary key.
GALTable::count(): Count rows that match the given GALExpression.
GALTable::countFields(): Returns the number of fields contained in a result.
GALTable::delete(): Deletes the row identified by $key from the database.
GALTable::extendedCount(): Template for complex count queries.
GALTable::extendedLoad(): Template for complex queries.
GALTable::fullKey(): Checks if the specified fields in $keys are the full primary key.
GALTable::getFields(): Returns all fields contained in this result.
GALTable::getFlags(): Gets the flags of the given field.
GALTable::getIfRegistered(): Return the row with the submitted primary key values, if it has been registered before.
GALTable::getLength(): Gets the length of the given field.
GALTable::getName(): Returns this table's name.
GALTable::getParent(): Returns a reference to this table.
GALTable::getPrimaryKey(): Returns the primary key of this table.
GALTable::getResultFactory(): Returns the factory to construct results.
GALTable::getRowFactory(): Returns the factory to construct rows.
GALTable::getTable(): Gets the name of the table the given field is contained in.
GALTable::getType(): Gets the type of the given field.
GALTable::insert(): Inserts a row into this table.
GALTable::insertMultiple(): Inserts multiple rows into the database.
GALTable::isField(): Checks if the given field is contained in a result.
GALTable::load(): Load rows that match the given GALExpression.
GALTable::rawCount(): Counts rows from this table.
GALTable::rawLoad(): Loads rows from this table.
GALTable::register(): Registers the specified row or returns an already registered row.
GALTable::registered(): Checks if the specified row is already registered.
GALTable::row(): Fetches a row matching the given key from the database.
GALTable::setRegistered(): Set the entry in $rows specified by &$keys to the specified value.
GALTable::stripKeys(): Removes all fields from the submitted data which belong to the primary key.
GALTable::unregister(): Removes a registered row.
GALTable::updateRow(): Sets the fields of the specified row to the specified values.
GALTable::validFields(): Checks if all the field names submitted in $fields are valid.
GALTable::__destruct(): Destructs all rows stored in $rows.

Class Details

[line 39]
Manage groups and handle database communication.

Only one instance of this class should exist for one database connection, i.e. one instance of GALGallery. This is assured inside __construct(). Most work is done by inherited methods from GALTable.

[ Top ]

Class Methods

constructor __construct [line 53]

GALGroups __construct(
GALGallery
$glb)

Initializes using a GALGallery object.

This constructor shouldn't be called by a library user, the representations for the used tables are automatically created by the GALGallery object.

Checks if an instance of GALGroups already exists in the specified GALGallery. If this is the case, this method throws an GAL_EGroup. If not, it reads necessary information for further initialization from $glb.

Tags:

see:

GALTable::__construct()

Overrides GALGallueTable::__construct() (Initializes $glb object variable.)

Parameters:

GALGallery

$glb

Necessary information for initialization.

[ Top ]

method add [line 103]

GALGroup add(
array
$values, [bool
$super = false])

Create a new GALGroup.

The parameter $values is an associative array with the following fields:

$values['owner'] GALUser optional The new group's owner, default: The user currently logged in.
$values['permission'] int required The new group's permission, values GAL_PERMISSION_PRIVATE, GAL_PERMISSION_PROTECTED or GAL_PERMISSION_PUBLIC.
$values['tag'] int optional The new group's tag.
$values['sortHint'] int optional The sortHint flag, used to arrange items in a defined order, default '0'.
$values['title'] string recommended The new group's title, default '(none)'.
$values['comment'] string recommended The new group's commentary text, default ''.
$values['direction'] string optional The text direction, one of 'ltr' or 'rtl', default 'ltr'.

Tags:

return:

the newly created group.

Parameters:

array	$values	Array with data for group creation.
bool	$super	If true, override permission checks.

[ Top ]

method buildResult [line 84]

GALGroupIterator buildResult(
resource
$result)

Creates a GALGroupIterator.

This method is used to build an iterator from a query result. It re-implements the GALResultFactory::buildResult() method.

Overrides GALTable::buildResult() (Implements the GALResultFactory interface.)

Parameters:

resource

$result

[ Top ]

method visible [line 65]

GALExpression visible(
)

SQL expression that is TRUE only for items visible to the user currently logged in.

Tags:

return:

A SQL logical expression that evaluates to TRUE for visible items.

Overrides GALGallueTable::visible() (SQL expression that is TRUE only for items visible to the user currently logged in.)

[ Top ]

method writeable [line 73]

GALExpression writeable(
)

SQL expression that is TRUE only for items writeable by the user currently logged in.

Tags:

return:

A SQL logical expression that evaluates to TRUE for writeable items.

Overrides GALGallueTable::writeable() (SQL expression that is TRUE only for items writeable by the user currently logged in.)

[ Top ]

Documentation generated on Wed, 16 Aug 2006 15:36:08 +0200 by phpDocumentor 1.3.0RC6