contenido\classes\class.inuse.php

Show:

inherited

Classes
- \InUseCollection
- \InUseItem

Table of Contents

Project: Contenido Content Management System

Description: Contenido In-Use classes

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-07-18 modified 2008-06-30, Dominik Ziegler, add security fix $Id: class.inuse.php 421 2008-06-30 13:39:59Z dominik.ziegler $: }}
Version: 1.0.8

\InUseCollection
jump to top

Package: Default

Class InUse Class for In-Use management

Parent(s): \ItemCollection
Author: Timo A. Hummel
Copyright: four for business 2003
Version: 0.1

Properties

array $_JoinPartners

inherited

Reverse join partners for this data object

Inherited from: \ItemCollection::$$_JoinPartners

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_JoinPartners

string $_encoding

inherited

Encoding

Inherited from: \ItemCollection::$$_encoding

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$_encoding

array $_forwardJoinPartners

inherited

Forward join partners for this data object

Inherited from: \ItemCollection::$$_forwardJoinPartners

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_forwardJoinPartners

array $_groupConditions

inherited

Group conditions

Inherited from: \ItemCollection::$$_groupConditions

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_groupConditions

array $_innerGroupConditions = array()

inherited

Inner group conditions

Inherited from: \ItemCollection::$$_innerGroupConditions

Default valuearray()Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_innerGroupConditions

string $_itemClass

inherited

Single item class

Inherited from: \ItemCollection::$$_itemClass

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$_itemClass

object $_iteratorItem

inherited

Iterator object for the next() method

Inherited from: \ItemCollection::$$_iteratorItem

Details

Type: object
Access: private
Inherited_from: \ItemCollection::$$_iteratorItem

array $_resultFields = array()

inherited

Result fields for the query

Inherited from: \ItemCollection::$$_resultFields

Default valuearray()Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_resultFields

array $_whereRestriction

inherited

Where restrictions for the query

Inherited from: \ItemCollection::$$_whereRestriction

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$_whereRestriction

array $cache

inherited

Cache the result items

Inherited from: \ItemCollection::$$cache

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$cache

object $db

inherited

DB_Contenido instance

Inherited from: \ItemCollection::$$db

Details

Type: object
Access: private
Inherited_from: \ItemCollection::$$db

string $lasterror

inherited

Storage of the last error

Inherited from: \ItemCollection::$$lasterror

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$lasterror

int $lifetime

inherited

Lifetime in seconds

Inherited from: \ItemCollection::$$lifetime

Details

Type: int
Access: private
Inherited_from: \ItemCollection::$$lifetime

string $objects

inherited

Storage of all result items

Inherited from: \ItemCollection::$$objects

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$objects

string $primaryKey

inherited

Storage of the primary key

Inherited from: \ItemCollection::$$primaryKey

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$primaryKey

array $properties

inherited

Property collection

Inherited from: \ItemCollection::$$properties

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$properties

string $table

inherited

Storage of the source table to use for the information

Inherited from: \ItemCollection::$$table

Details

Type: string
Access: private
Inherited_from: \ItemCollection::$$table

array $virgin

inherited

Is entry virgin?

Inherited from: \ItemCollection::$$virgin

Details

Type: array
Access: private
Inherited_from: \ItemCollection::$$virgin

Methods

InUseCollection() : void

Constructor Function

ItemCollection(string $table, $primaryKey, $lifetime = 10) : void

inherited

Constructor Function Note: Default lifetime is 10 seconds.

Inherited from: \ItemCollection::ItemCollection()

Parameters

Name	Type	Description
$table	string	The table to use as information source
$primaryKey
$lifetime

_buildGroupWhereStatements() : array

inherited

_buildGroupWhereStatements ()

Inherited from: \ItemCollection::_buildGroupWhereStatements()

Builds a where statement out of the setGroupWhere calls

Returns

Type	Description
array	with all where statements

_buildWhereStatements() : array

inherited

_buildWhereStatements ()

Inherited from: \ItemCollection::_buildWhereStatements()

Builds a where statement out of the setWhere calls

Returns

Type	Description
array	with all where statements

_fetchJoinTables(\none $ignore_root) : array

inherited

_fetchJoinTables ()

Inherited from: \ItemCollection::_fetchJoinTables()

Fetches all tables which will be joined later on.

The returned array has the following format:

array( array(fields), array(tables), array(joins), array(wheres) );

Notes: The table is the table name which needs to be added to the FROM clause The join statement which is inserted after the master table The where statement is combined with all other where statements The fields to select from

Parameters

Name	Type	Description
$ignore_root	\none

Returns

Type	Description
array	see above

_findReverseJoinPartner( $parentclass, $classname) : void

inherited

Inherited from: \ItemCollection::_findReverseJoinPartner()

Parameters

Name	Type	Description
$parentclass
$classname

_initializeDriver( $bForceInit = false) : void

inherited

_initializeDriver: Initializes the driver to use with GenericDB.

Inherited from: \ItemCollection::_initializeDriver()

Parameters

Name	Type	Description
$bForceInit		boolean If true, forces the driver to initialize, even if it already exists.

_recursiveStructuredFetch( $objects, $array) : void

inherited

Inherited from: \ItemCollection::_recursiveStructuredFetch()

Parameters

Name	Type	Description
$objects
$array

_resolveLinks() : void

inherited

Inherited from: \ItemCollection::_resolveLinks()

_setItemClass(string $classname) : \none

inherited

_setItemClass: private method to set the accompanying item object.

Inherited from: \ItemCollection::_setItemClass()

Parameters

Name	Type	Description
$classname	string	specifies the classname

Returns

Type	Description
\none

_setJoinPartner(string $foreignCollectionClass) : \none

inherited

_setJoinPartner: Defines the reverse links for this table.

Inherited from: \ItemCollection::_setJoinPartner()

Important: The class specified by $foreignCollectionClass needs to be a collection class and has to exist Define all links in the constructor of your object

Parameters

Name	Type	Description
$foreignCollectionClass	string	Specifies the foreign class to use

Returns

Type	Description
\none

addResultField( $field) : void

inherited

Inherited from: \ItemCollection::addResultField()

Parameters

Name	Type	Description
$field

checkAndMark( $type,  $objectid,  $returnWarning = false,  $warningTemplate = "",  $allowOverride = false,  $location = "") : mixed

Checks and marks if not marked.

Example: Check for "idmod", also return a lock message: list($inUse, $message) = $col->checkAndMark("idmod", $idmod, true, i18n("Module is in use by %s (%s)"));

Example 2: Check for "idmod", don't return a lock message $inUse = $col->checkAndMark("idmod", $idmod);

Parameters

Name	Type	Description
$type		string Specifies the type to de-mark.
$objectid		mixed Specifies the object ID
$returnWarning		boolean If true, also returns an error message if in use
$warningTemplate		string String to fill with the template (%s as placeholder, first %s is the username, second is the real name)
$allowOverride		boolean True if the user can override the lock
$location		string Value to append to the override lock button

Returns

Type	Description
mixed	If returnWarning is false, returns a boolean value wether the object is locked. If returnWarning is true, returns a 2 item array (boolean inUse, string errormessage).

checkMark( $type, $objectid) : int

Checks if a specific item is marked

Parameters

Name	Type	Description
$type		string Specifies the type to de-mark.
$objectid		mixed Specifies the object ID

Returns

Type	Description
int	Returns false if it's not in use or returns the object if it is.

count() : integer

inherited

count () Returns the amount of returned items

Inherited from: \ItemCollection::count()

Returns

Type	Description
integer	Number of rows

create() : void

inherited

create() Creates a new item in the table and loads it afterwards.

Inherited from: \ItemCollection::create()

delete( $id) : void

inherited

delete() Deletes an item in the table.

Inherited from: \ItemCollection::delete()

Parameters

Name	Type	Description
$id

deleteWhere( $field, $restriction, $operator = "=") : void

inherited

deleteWhere ($field, $restriction, $operator)

Inherited from: \ItemCollection::deleteWhere()

Restricts a query with a where clause

Parameters

Name	Type	Description
$field
$restriction
$operator

deleteWhereGroup( $group, $field, $restriction, $operator = "=") : void

inherited

deleteWhereGroup ($group, $field, $restriction, $operator)

Inherited from: \ItemCollection::deleteWhereGroup()

Restricts a query with a where clause, groupable

Parameters

Name	Type	Description
$group
$field
$restriction
$operator

exists(integer $id) : boolean

inherited

exists ($id) Checks if a specific entry exists

Inherited from: \ItemCollection::exists()

Parameters

Name	Type	Description
$id	integer	The id to check for

Returns

Type	Description
boolean	true if object exists, false if not

fetchArray( $key, $fields) : array

inherited

fetchArray() Fetches an array of fields from the database.

Inherited from: \ItemCollection::fetchArray()

Example: $i = $object->fetchArray("idartlang", array("idlang", "name"));

could result in: $i[5] = array("idlang" => 5, "name" => "My Article");

Important: If you don't pass an array for fields, the function doesn't create an array.

Parameters

Name	Type	Description
$key		string Name of the field to use for the key
$fields		mixed String or array

Returns

Type	Description
array	Resulting array

fetchObject( $class) : void

inherited

Inherited from: \ItemCollection::fetchObject()

Parameters

Name	Type	Description
$class

fetchTable( $fields = array(), $objects = array()) : void

inherited

Inherited from: \ItemCollection::fetchTable()

Parameters

Name	Type	Description
$fields
$objects

flexSelect(string $distinct = "", string $from = "", string $where = "", string $group_by = "", string $order_by = "", string $limit = "") : array

inherited

flexSelect ($distinct = "", $from = "", $where = "", $group_by = "", $order_by = "", $limit = "") Selects all entries from the database and returns them as DBObject-objects to the user.

Inherited from: \ItemCollection::flexSelect()

Objects are loaded using their primary key.

Parameters

Name	Type	Description
$distinct	string	Specifies if distinct will be added to the SQL statement ($distinct !== "" -> DISTINCT)
$from	string	Specifies the additional from clause (e.g. "con_news_groups AS groups, con_news_groupmembers AS groupmembers").
$where	string	Specifies the where clause.
$group_by	string	Specifies the group by clause.
$order_by	string	Specifies the order by clause.
$limit	string	Specifies the limit by clause.

Returns

Type	Description
array	Array of DBObject-Objects

Details

Author: HerrB

link( $foreignClass) : void

inherited

sets the query to use foreign tables in the resultset

Inherited from: \ItemCollection::link()

Parameters

Name	Type	Description
$foreignClass

loadItem( $vitem) : object

inherited

loadItem ($item) Loads a single object from the database.

Inherited from: \ItemCollection::loadItem()

Needs to be overridden by the extension class.

Parameters

Name	Type	Description
$vitem

Returns

Type	Description
object	The newly created object

markInUse( $type, $objectid, $session, $user) : void

Marks a specific object as "in use".

Note that items are released when the session is destroyed.

Currently, the following types are defined and approved as internal Contenido standard: article module layout template

Parameters

Name	Type	Description
$type		string Specifies the type to mark.
$objectid		mixed Specifies the object ID
$session		string Specifies the session for which the "in use" mark is valid
$user		string Specifies the user which requested the in-use flag

next() : object

inherited

next () Advances to the next item in the database.

Inherited from: \ItemCollection::next()

Returns

Type	Description
object	The next object, or false if no more objects

query() : void

inherited

Inherited from: \ItemCollection::query()

queryAndFetchStructured(\objects $objects) : array

inherited

fetchStructured Returns an array of arrays

Inherited from: \ItemCollection::queryAndFetchStructured()

Parameters

Name	Type	Description
$objects	\objects	array with the correct order of the objects

Returns

Type	Description
array	result

removeItemMarks( $type, $itemid) : void

Removes the mark for a specific item

Parameters

Name	Type	Description
$type		string Specifies the type to de-mark.
$itemid		string Specifies the item

removeMark( $type, $objectid, $session) : void

Removes the "in use" mark from a specific object.

Parameters

Name	Type	Description
$type		string Specifies the type to de-mark.
$objectid		mixed Specifies the object ID
$session		string Specifies the session for which the "in use" mark is valid

removeResultField( $field) : void

inherited

Inherited from: \ItemCollection::removeResultField()

Parameters

Name	Type	Description
$field

removeSessionMarks( $session) : void

Removes all in-use marks for a specific session.

Parameters

Name	Type	Description
$session		string Specifies the session for which the "in use" marks should be removed

removeTypeMarks( $type, $session) : void

Removes all marks for a specific type and session

Parameters

Name	Type	Description
$type		string Specifies the type to de-mark.
$session		string Specifies the session for which the "in use" mark is valid

resetQuery() : void

inherited

Inherited from: \ItemCollection::resetQuery()

select(string $where = "", string $group_by = "", string $order_by = "", string $limit = "") : array

inherited

select ($where = "", $group_by = "", $order_by = "", $limit = "") Selects all entries from the database and returns them as DBObject-objects to the user.

Inherited from: \ItemCollection::select()

Objects are loaded using their primary key.

Parameters

Name	Type	Description
$where	string	Specifies the where clause.
$group_by	string	Specifies the group by clause.
$order_by	string	Specifies the order by clause.
$limit	string	Specifies the limit by clause.

Returns

Type	Description
array	Array of DBObject-Objects

setEncoding( $sEncoding) : void

inherited

Inherited from: \ItemCollection::setEncoding()

Parameters

Name	Type	Description
$sEncoding

setGroupCondition( $group1, $group2, $condition = "AND") : void

inherited

setGroupCondition ($group1, $group2, $condition)

Inherited from: \ItemCollection::setGroupCondition()

Defines how groups are linked to each other

Parameters

Name	Type	Description
$group1
$group2
$condition

setInnerGroupCondition( $group, $condition = "AND") : void

inherited

setInnerGroupCondition ($group, $condition)

Inherited from: \ItemCollection::setInnerGroupCondition()

Defines how relations in one group are linked each together

Parameters

Name	Type	Description
$group
$condition

setLimit( $iRowStart, $iRowCount) : void

inherited

Inherited from: \ItemCollection::setLimit()

Parameters

Name	Type	Description
$iRowStart
$iRowCount

setOrder( $order) : void

inherited

Inherited from: \ItemCollection::setOrder()

Parameters

Name	Type	Description
$order

setWhere( $field, $restriction, $operator = "=") : void

inherited

setWhere ($field, $restriction, $operator)

Inherited from: \ItemCollection::setWhere()

Restricts a query with a where clause

Parameters

Name	Type	Description
$field
$restriction
$operator

setWhereGroup( $group, $field, $restriction, $operator = "=") : void

inherited

setWhereGroup ($group, $field, $restriction, $operator)

Inherited from: \ItemCollection::setWhereGroup()

Restricts a query with a where clause, groupable

Parameters

Name	Type	Description
$group
$field
$restriction
$operator

\InUseItem
jump to top

Package: Default

Class InUseItem Class for a single in-use item

Parent(s): \Item
Author: Timo A. Hummel
Copyright: four for business 2003
Version: 0.1

Properties

array $_arrInFilters = array('urlencode', 'conHtmlSpecialChars', 'addslashes')

inherited

Array storing the funcion names of the filters used when data is stored to the db

Inherited from: \Item::$$_arrInFilters

Default valuearray('urlencode', 'conHtmlSpecialChars', 'addslashes')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrInFilters

array $_arrOutFilters = array('stripslashes', 'htmldecode', 'urldecode')

inherited

Array storing the funcion names of the filters used when data is retrieved from the db

Inherited from: \Item::$$_arrOutFilters

Default valuearray('stripslashes', 'htmldecode', 'urldecode')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrOutFilters

$_metaObject

inheritedInherited from: \Item::$$_metaObject

Details

Type: n/a
Inherited_from: \Item::$$_metaObject

array $cache

inherited

Cache the result items

Inherited from: \Item::$$cache

Details

Type: array
Access: private
Inherited_from: \Item::$$cache

object $db

inherited

DB_Contenido instance

Inherited from: \Item::$$db

Details

Type: object
Access: private
Inherited_from: \Item::$$db

string $lasterror

inherited

Storage of the last error

Inherited from: \Item::$$lasterror

Details

Type: string
Access: private
Inherited_from: \Item::$$lasterror

int $lifetime

inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime

Details

Type: int
Access: private
Inherited_from: \Item::$$lifetime

array $modifiedValues

inherited

Storage of the fields which were modified

Inherited from: \Item::$$modifiedValues

Details

Type: array
Access: private
Inherited_from: \Item::$$modifiedValues

string $oldPrimaryKey

inherited

stores the old primary key, just in case somebody wants to change it

Inherited from: \Item::$$oldPrimaryKey

Details

Type: string
Access: private
Inherited_from: \Item::$$oldPrimaryKey

object $primaryKey

inherited

Primary key of the table

Inherited from: \Item::$$primaryKey

Details

Type: object
Access: private
Inherited_from: \Item::$$primaryKey

object $properties

inherited

PropertyCollection object

Inherited from: \Item::$$properties

Details

Type: object
Access: private
Inherited_from: \Item::$$properties

string $table

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$table

Details

Type: string
Access: private
Inherited_from: \Item::$$table

array $values

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$values

Details

Type: array
Access: private
Inherited_from: \Item::$$values

boolean $virgin

inherited

Checks for the virginity of this object.

Inherited from: \Item::$$virgin

If true, the object is virgin and no operations on it except load-Functions are allowed.

Details

Type: boolean
Access: private
Inherited_from: \Item::$$virgin

Methods

InUseItem() : void

Constructor Function

Item(string $table = "", string $primaryKey = "", $lifetime = 10) : void

inherited

Constructor Function

Inherited from: \Item::Item()

Parameters

Name	Type	Description
$table	string	The table to use as information source
$primaryKey	string	The primary key to use
$lifetime

_inFilter(mixed $data) : mixed

inherited

Filters the passed data using the functions defines in the _arrInFilters array.

Inherited from: \Item::_inFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_onLoad() : \none

inherited

_onLoad ()

Inherited from: \Item::_onLoad()

Function which is called whenever an item is loaded. Inherited classes should override this function if desired.

Returns

Type	Description
\none

_outFilter(mixed $data) : mixed

inherited

Filters the passed data using the functions defines in the _arrOutFilters array.

Inherited from: \Item::_outFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_setMetaObject( $objectname) : void

inherited

Inherited from: \Item::_setMetaObject()

Parameters

Name	Type	Description
$objectname

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

inherited

deleteProperty ($type, $name) Deletes a custom property

Inherited from: \Item::deleteProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

get(string $field) : mixed

inherited

get($field) Wrapper for getField (less to type)

Inherited from: \Item::get()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getField(string $field) : mixed

inherited

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

Inherited from: \Item::getField()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getMetaObject() : void

inherited

Inherited from: \Item::getMetaObject()

getProperty(string $type, string $name) : boolean

inherited

getProperty ($type, $name) Sets a custom property

Inherited from: \Item::getProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

Returns

Type	Description
boolean	Value of the given property

loadBy(string $field, string $value, bool $bSafe = true) : bool

inherited

loadBy ($field, $value) Loads an item by colum/field from the database

Inherited from: \Item::loadBy()

Parameters

Name	Type	Description
$field	string	Specifies the field
$value	string	Specifies the value
$bSafe	bool	use inFilter or not

Returns

Type	Description
bool	True if the load was successful

loadByPrimaryKey(string $value) : bool

inherited

loadByPrimaryKey ($value) Loads an item by ID from the database

Inherited from: \Item::loadByPrimaryKey()

Parameters

Name	Type	Description
$value	string	Specifies the primary key value

Returns

Type	Description
bool	True if the load was successful

set(string $field, string $value, $safe = true) : void

inherited

set($field, $value) Shortcut to setField

Inherited from: \Item::set()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe

setField(string $field, string $value, boolean $safe = true) : void

inherited

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

Inherited from: \Item::setField()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe	boolean	Speficies if we should translate characters

setFilters(array $arrInFilters = array(), array $arrOutFilters = array()) : void

inherited

Define the filter functions used when data is being stored or retrieved from the database.

Inherited from: \Item::setFilters()

Examples:

$obj->setFilters(array('addslashes'), array('stripslashes')); $obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));

Parameters

Name	Type	Description
$arrInFilters	array	inFilters array with function names
$arrOutFilters	array	outFilters array with function names

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

inherited

setProperty ($type, $name, $value) Sets a custom property

Inherited from: \Item::setProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name
$value	string	Specifies the value

store() : void

inherited

store() Stores the modified user object to the database

Inherited from: \Item::store()

contenido\classes\class.inuse.php

\InUseCollectionjump to top

Properties

Methods

\InUseItemjump to top

Properties

Methods

\InUseCollection
jump to top

\InUseItem
jump to top