contenido\classes\class.todo.php

Show:

inherited

Classes

Table of Contents

Project: Contenido Content Management System

Description: TODO / Reminder System

Requirements:

Author: unknown
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 unknown modified 2008-06-30, Frederic Schneider, add security fix $Id: class.todo.php 405 2008-06-30 11:06:03Z frederic.schneider $: }}
Version: 1.0.1

\TODOCollection
jump to top

Package: Default

Class ItemCollection Class for database based item collections

Parent(s): \CommunicationCollection < \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 \CommunicationCollection::$$_JoinPartners

Details

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

string $_encoding

inherited

Encoding

Inherited from: \ItemCollection::$$_encoding \CommunicationCollection::$$_encoding

Details

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

array $_forwardJoinPartners

inherited

Forward join partners for this data object

Inherited from: \ItemCollection::$$_forwardJoinPartners \CommunicationCollection::$$_forwardJoinPartners

Details

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

array $_groupConditions

inherited

Group conditions

Inherited from: \ItemCollection::$$_groupConditions \CommunicationCollection::$$_groupConditions

Details

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

array $_innerGroupConditions = array()

inherited

Inner group conditions

Inherited from: \ItemCollection::$$_innerGroupConditions \CommunicationCollection::$$_innerGroupConditions

Default valuearray()Details

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

string $_itemClass

inherited

Single item class

Inherited from: \ItemCollection::$$_itemClass \CommunicationCollection::$$_itemClass

Details

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

object $_iteratorItem

inherited

Iterator object for the next() method

Inherited from: \ItemCollection::$$_iteratorItem \CommunicationCollection::$$_iteratorItem

Details

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

array $_resultFields = array()

inherited

Result fields for the query

Inherited from: \ItemCollection::$$_resultFields \CommunicationCollection::$$_resultFields

Default valuearray()Details

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

array $_whereRestriction

inherited

Where restrictions for the query

Inherited from: \ItemCollection::$$_whereRestriction \CommunicationCollection::$$_whereRestriction

Details

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

array $cache

inherited

Cache the result items

Inherited from: \ItemCollection::$$cache \CommunicationCollection::$$cache

Details

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

object $db

inherited

DB_Contenido instance

Inherited from: \ItemCollection::$$db \CommunicationCollection::$$db

Details

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

string $lasterror

inherited

Storage of the last error

Inherited from: \ItemCollection::$$lasterror \CommunicationCollection::$$lasterror

Details

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

int $lifetime

inherited

Lifetime in seconds

Inherited from: \ItemCollection::$$lifetime \CommunicationCollection::$$lifetime

Details

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

string $objects

inherited

Storage of all result items

Inherited from: \ItemCollection::$$objects \CommunicationCollection::$$objects

Details

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

string $primaryKey

inherited

Storage of the primary key

Inherited from: \ItemCollection::$$primaryKey \CommunicationCollection::$$primaryKey

Details

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

array $properties

inherited

Property collection

Inherited from: \ItemCollection::$$properties \CommunicationCollection::$$properties

Details

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

string $table

inherited

Storage of the source table to use for the information

Inherited from: \ItemCollection::$$table \CommunicationCollection::$$table

Details

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

array $virgin

inherited

Is entry virgin?

Inherited from: \ItemCollection::$$virgin \CommunicationCollection::$$virgin

Details

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

Methods

CommunicationCollection() : void

inherited

Constructor Function

Inherited from: \CommunicationCollection::CommunicationCollection()

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

inherited

Constructor Function Note: Default lifetime is 10 seconds.

Inherited from: \ItemCollection::ItemCollection()\CommunicationCollection::ItemCollection()

Parameters

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

TODOCollection() : void

_buildGroupWhereStatements() : array

inherited

_buildGroupWhereStatements ()

Inherited from: \ItemCollection::_buildGroupWhereStatements()\CommunicationCollection::_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()\CommunicationCollection::_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()\CommunicationCollection::_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()\CommunicationCollection::_findReverseJoinPartner()

Parameters

Name	Type	Description
$parentclass
$classname

_initializeDriver( $bForceInit = false) : void

inherited

_initializeDriver: Initializes the driver to use with GenericDB.

Inherited from: \ItemCollection::_initializeDriver()\CommunicationCollection::_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()\CommunicationCollection::_recursiveStructuredFetch()

Parameters

Name	Type	Description
$objects
$array

_resolveLinks() : void

inherited

Inherited from: \ItemCollection::_resolveLinks()\CommunicationCollection::_resolveLinks()

_setItemClass(string $classname) : \none

inherited

_setItemClass: private method to set the accompanying item object.

Inherited from: \ItemCollection::_setItemClass()\CommunicationCollection::_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()\CommunicationCollection::_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()\CommunicationCollection::addResultField()

Parameters

Name	Type	Description
$field

count() : integer

inherited

count () Returns the amount of returned items

Inherited from: \ItemCollection::count()\CommunicationCollection::count()

Returns

Type	Description
integer	Number of rows

create( $itemtype,  $itemid,  $reminderdate,  $subject,  $content,  $notimail,  $notibackend,  $recipient) : void

Creates a new communication item

Parameters

Name	Type	Description
$itemtype
$itemid
$reminderdate
$subject
$content
$notimail
$notibackend
$recipient

delete( $id) : void

inherited

delete() Deletes an item in the table.

Inherited from: \ItemCollection::delete()\CommunicationCollection::delete()

Parameters

Name	Type	Description
$id

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

inherited

deleteWhere ($field, $restriction, $operator)

Inherited from: \ItemCollection::deleteWhere()\CommunicationCollection::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()\CommunicationCollection::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()\CommunicationCollection::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()\CommunicationCollection::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()\CommunicationCollection::fetchObject()

Parameters

Name	Type	Description
$class

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

inherited

Inherited from: \ItemCollection::fetchTable()\CommunicationCollection::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()\CommunicationCollection::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

getPriorityTypes() : void

getStatusTypes() : void

link( $foreignClass) : void

inherited

sets the query to use foreign tables in the resultset

Inherited from: \ItemCollection::link()\CommunicationCollection::link()

Parameters

Name	Type	Description
$foreignClass

loadItem( $vitem) : object

inherited

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

Inherited from: \ItemCollection::loadItem()\CommunicationCollection::loadItem()

Needs to be overridden by the extension class.

Parameters

Name	Type	Description
$vitem

Returns

Type	Description
object	The newly created object

next() : object

inherited

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

Inherited from: \ItemCollection::next()\CommunicationCollection::next()

Returns

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

query() : void

inherited

Inherited from: \ItemCollection::query()\CommunicationCollection::query()

queryAndFetchStructured(\objects $objects) : array

inherited

fetchStructured Returns an array of arrays

Inherited from: \ItemCollection::queryAndFetchStructured()\CommunicationCollection::queryAndFetchStructured()

Parameters

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

Returns

Type	Description
array	result

removeResultField( $field) : void

inherited

Inherited from: \ItemCollection::removeResultField()\CommunicationCollection::removeResultField()

Parameters

Name	Type	Description
$field

resetQuery() : void

inherited

Inherited from: \ItemCollection::resetQuery()\CommunicationCollection::resetQuery()

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

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

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()\CommunicationCollection::setEncoding()

Parameters

Name	Type	Description
$sEncoding

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

inherited

setGroupCondition ($group1, $group2, $condition)

Inherited from: \ItemCollection::setGroupCondition()\CommunicationCollection::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()\CommunicationCollection::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()\CommunicationCollection::setLimit()

Parameters

Name	Type	Description
$iRowStart
$iRowCount

setOrder( $order) : void

inherited

Inherited from: \ItemCollection::setOrder()\CommunicationCollection::setOrder()

Parameters

Name	Type	Description
$order

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

inherited

setWhere ($field, $restriction, $operator)

Inherited from: \ItemCollection::setWhere()\CommunicationCollection::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()\CommunicationCollection::setWhereGroup()

Restricts a query with a where clause, groupable

Parameters

Name	Type	Description
$group
$field
$restriction
$operator

\TODOItem
jump to top

Package: Default

Single CommunicationItem Item

Parent(s): \CommunicationItem < \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 \CommunicationItem::$$_arrInFilters

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

Type: array
Access: private
Inherited_from: \Item::$$_arrInFilters
Inherited_from: \CommunicationItem::$$_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 \CommunicationItem::$$_arrOutFilters

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

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

$_metaObject

inheritedInherited from: \Item::$$_metaObject \CommunicationItem::$$_metaObject

Details

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

array $cache

inherited

Cache the result items

Inherited from: \Item::$$cache \CommunicationItem::$$cache

Details

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

object $db

inherited

DB_Contenido instance

Inherited from: \Item::$$db \CommunicationItem::$$db

Details

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

string $lasterror

inherited

Storage of the last error

Inherited from: \Item::$$lasterror \CommunicationItem::$$lasterror

Details

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

int $lifetime

inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime \CommunicationItem::$$lifetime

Details

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

array $modifiedValues

inherited

Storage of the fields which were modified

Inherited from: \Item::$$modifiedValues \CommunicationItem::$$modifiedValues

Details

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

string $oldPrimaryKey

inherited

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

Inherited from: \Item::$$oldPrimaryKey \CommunicationItem::$$oldPrimaryKey

Details

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

object $primaryKey

inherited

Primary key of the table

Inherited from: \Item::$$primaryKey \CommunicationItem::$$primaryKey

Details

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

object $properties

inherited

PropertyCollection object

Inherited from: \Item::$$properties \CommunicationItem::$$properties

Details

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

string $table

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$table \CommunicationItem::$$table

Details

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

array $values

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$values \CommunicationItem::$$values

Details

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

boolean $virgin

inherited

Checks for the virginity of this object.

Inherited from: \Item::$$virgin \CommunicationItem::$$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
Inherited_from: \CommunicationItem::$$virgin

Methods

CommunicationItem() : void

inherited

Constructor Function

Inherited from: \CommunicationItem::CommunicationItem()

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

inherited

Constructor Function

Inherited from: \Item::Item()\CommunicationItem::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()\CommunicationItem::_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()\CommunicationItem::_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()\CommunicationItem::_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()\CommunicationItem::_setMetaObject()

Parameters

Name	Type	Description
$objectname

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

inherited

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

Inherited from: \Item::deleteProperty()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::getMetaObject()

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

inherited

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

Inherited from: \Item::getProperty()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::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()\CommunicationItem::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

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

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: \CommunicationItem::store()

\TODOLink
jump to top

Package: Default

HTML Link

Parent(s): \cHTMLLink < \cHTML < \HTML_Common
Author: Timo A. Hummel

Properties

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions \cHTMLLink::$$_aEventDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aEventDefinitions
Inherited_from: \cHTMLLink::$$_aEventDefinitions

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cHTMLLink::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cHTMLLink::$$_aStyleDefinitions

$_anchor

inheritedInherited from: \cHTMLLink::$$_anchor

Details

Type: n/a
Inherited_from: \cHTMLLink::$$_anchor

$_content

inherited

The content itself

Inherited from: \cHTMLLink::$$_content

Details

Type: n/a
Inherited_from: \cHTMLLink::$$_content

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag \cHTMLLink::$$_contentlessTag

Details

Type: boolean
Access: private
Inherited_from: \cHTML::$$_contentlessTag
Inherited_from: \cHTMLLink::$$_contentlessTag

$_custom

inheritedInherited from: \cHTMLLink::$$_custom

Details

Type: n/a
Inherited_from: \cHTMLLink::$$_custom

$_link

inheritedInherited from: \cHTMLLink::$$_link

Details

Type: n/a
Inherited_from: \cHTMLLink::$$_link

array $_requiredScripts

inherited

Defines all scripts which are required by the current element

Inherited from: \cHTML::$$_requiredScripts \cHTMLLink::$$_requiredScripts

Details

Type: array
Access: private
Inherited_from: \cHTML::$$_requiredScripts
Inherited_from: \cHTMLLink::$$_requiredScripts

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cHTMLLink::$$_skeleton_close

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_close
Inherited_from: \cHTMLLink::$$_skeleton_close

string $_skeleton_open

inherited

Storage of the open SGML tag template

Inherited from: \cHTML::$$_skeleton_open \cHTMLLink::$$_skeleton_open

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_open
Inherited_from: \cHTMLLink::$$_skeleton_open

string $_skeleton_single

inherited

Storage of a single SGML tag template

Inherited from: \cHTML::$$_skeleton_single \cHTMLLink::$$_skeleton_single

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_single
Inherited_from: \cHTMLLink::$$_skeleton_single

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs \cHTMLLink::$$_styledefs

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_styledefs
Inherited_from: \cHTMLLink::$$_styledefs

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag \cHTMLLink::$$_tag

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_tag
Inherited_from: \cHTMLLink::$$_tag

Methods

TODOLink( $itemtype, $itemid, $subject, $message) : void

Parameters

Name	Type	Description
$itemtype
$itemid
$subject
$message

__toString() : string

inherited

Direct call of object as string will return it's generated markup.

Inherited from: \cHTML::__toString()\cHTMLLink::__toString()

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLLink::_setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()\cHTMLLink::addRequiredScript()

Parameters

Name	Type	Description
$script

advanceID() : void

inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLLink::advanceID()

This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.

attachEventDefinition( $sName, $sEvent, $sCode) : void

inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cHTMLLink::attachEventDefinition()

Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");

Parameters

Name	Type	Description
$sName		string defines the name of the event
$sEvent		string defines the event (e.g. onClick)
$sCode		string defines the code

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLLink::attachStyleDefinition()

This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.

$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");

Results in:

style="border: 1px solid black; white-space: nowrap; padding: 0px;"

Parameters

Name	Type	Description
$sName		string Name for a style definition
$sDefinition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLLink::cHTML()

cHTMLLink( $href = "") : void

inherited

Constructor.

Inherited from: \cHTMLLink::cHTMLLink()

Creates an HTML link.

Parameters

Name	Type	Description
$href		String with the location to link to

disableAutomaticParameterAppend() : void

inherited

Inherited from: \cHTMLLink::disableAutomaticParameterAppend()

enableAutomaticParameterAppend() : void

inherited

Inherited from: \cHTMLLink::enableAutomaticParameterAppend()

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLLink::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $attributes) : string

inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cHTMLLink::fillSkeleton()

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

Parameters

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getHref() : void

inherited

Inherited from: \cHTMLLink::getHref()

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLLink::getID()

Returns

Type	Description
string	current ID

render() : string

inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLLink::render()

Returns

Type	Description
string	Rendered HTML

setAlt( $alt) : void

inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLLink::setAlt()

Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.

To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.

Parameters

Name	Type	Description
$alt		string Text to set as the "alt" attribute

setAnchor( $anchor) : void

inherited

setAnchor: Sets an anchor

Inherited from: \cHTMLLink::setAnchor()

Only works for the link types Link and cLink.

Parameters

Name	Type	Description
$anchor

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLLink::setAttribute()

Parameters

Name	Type	Description
$sAttributeName		string Name of the attribute
$sValue		string Value of the attribute

setCLink( $targetarea, $targetframe, $targetaction = "") : void

inherited

setLink: Sets a Contenido link (area, frame, action)

Inherited from: \cHTMLLink::setCLink()

Parameters

Name	Type	Description
$targetarea		string Target backend area
$targetframe		string Target frame (1-4)
$targetaction		string Target action

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLLink::setClass()

Parameters

Name	Type	Description
$class		string Text to set as the "alt" attribute

setContent( $content) : void

inherited

setContent: Sets the link's content

Inherited from: \cHTMLLink::setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()\cHTMLLink::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setCustom( $key, $value) : void

inherited

setCustom: Sets a custom attribute to be appended to the link

Inherited from: \cHTMLLink::setCustom()

Parameters

Name	Type	Description
$key		string Parameter name
$value		string Parameter value

setEvent( $event, $action) : void

inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cHTMLLink::setEvent()

example: $item->setEvent("change","document.forms[0].submit");

Parameters

Name	Type	Description
$event		string Type of the event
$action		string Function or action to call (JavaScript Code)

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLLink::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLLink::setID()

Parameters

Name	Type	Description
$id

setLink( $href) : void

inherited

setLink: Sets the link to a specific location

Inherited from: \cHTMLLink::setLink()

Parameters

Name	Type	Description
$href		String with the location to link to

setMultiLink( $righttoparea, $righttopaction, $rightbottomarea, $rightbottomaction) : void

inherited

setMultiLink: Sets a multilink

Inherited from: \cHTMLLink::setMultiLink()

Parameters

Name	Type	Description
$righttoparea		string Area (right top)
$righttopaction		string Action (right top)
$rightbottomarea		string Area (right bottom)
$rightbottomaction		string Action (right bottom)

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLLink::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLLink::setStyleDefinition()

Parameters

Name	Type	Description
$entity		string Entity to define
$definition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

setTargetFrame( $target) : void

inherited

setTargetFrame: Sets the target frame

Inherited from: \cHTMLLink::setTargetFrame()

Parameters

Name	Type	Description
$target		string Target frame identifier

toHTML() : string

inherited

Renders the link

Inherited from: \cHTMLLink::toHTML()

Returns

Type	Description
string	Rendered HTML

unsetEvent( $event) : void

inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()\cHTMLLink::unsetEvent()

example: $item->unsetEvent("change");

Parameters

Name	Type	Description
$event		string Type of the event

contenido\classes\class.todo.php

\TODOCollectionjump to top

Properties

Methods

\TODOItemjump to top

Properties

Methods

\TODOLinkjump to top

Properties

Methods

\TODOCollection
jump to top

\TODOItem
jump to top

\TODOLink
jump to top