contenido\classes\class.todo.php
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
- Parent(s)
- \CommunicationCollection < \ItemCollection
- Author
- Timo A. Hummel
- Copyright
- four for business 2003
- Version
- 0.1
Properties


array $_JoinPartners
Reverse join partners for this data object
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_JoinPartners
- Inherited_from
- \CommunicationCollection::$$_JoinPartners


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


array $_forwardJoinPartners
Forward join partners for this data object
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_forwardJoinPartners
- Inherited_from
- \CommunicationCollection::$$_forwardJoinPartners


array $_groupConditions
Group conditions
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_groupConditions
- Inherited_from
- \CommunicationCollection::$$_groupConditions


array $_innerGroupConditions = array()
Inner group conditions
array()
Details- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_innerGroupConditions
- Inherited_from
- \CommunicationCollection::$$_innerGroupConditions


string $_itemClass
Single item class
- Type
- string
- Access
- private
- Inherited_from
- \ItemCollection::$$_itemClass
- Inherited_from
- \CommunicationCollection::$$_itemClass


object $_iteratorItem
Iterator object for the next() method
- Type
- object
- Access
- private
- Inherited_from
- \ItemCollection::$$_iteratorItem
- Inherited_from
- \CommunicationCollection::$$_iteratorItem


array $_resultFields = array()
Result fields for the query
array()
Details- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_resultFields
- Inherited_from
- \CommunicationCollection::$$_resultFields


array $_whereRestriction
Where restrictions for the query
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$_whereRestriction
- Inherited_from
- \CommunicationCollection::$$_whereRestriction


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


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


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


int $lifetime
Lifetime in seconds
- Type
- int
- Access
- private
- Inherited_from
- \ItemCollection::$$lifetime
- Inherited_from
- \CommunicationCollection::$$lifetime


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


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


array $properties
Property collection
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$properties
- Inherited_from
- \CommunicationCollection::$$properties


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


array $virgin
Is entry virgin?
- Type
- array
- Access
- private
- Inherited_from
- \ItemCollection::$$virgin
- Inherited_from
- \CommunicationCollection::$$virgin
Methods


ItemCollection(string $table, $primaryKey, $lifetime = 10) : void
Constructor Function Note: Default lifetime is 10 seconds.
Inherited from: \ItemCollection::ItemCollection()\CommunicationCollection::ItemCollection()Name | Type | Description |
---|---|---|
$table | string | The table to use as information source |
$primaryKey | ||
$lifetime |


_buildGroupWhereStatements() : array
_buildGroupWhereStatements ()
Inherited from: \ItemCollection::_buildGroupWhereStatements()\CommunicationCollection::_buildGroupWhereStatements()Builds a where statement out of the setGroupWhere calls
Type | Description |
---|---|
array | with all where statements |


_buildWhereStatements() : array
_buildWhereStatements ()
Inherited from: \ItemCollection::_buildWhereStatements()\CommunicationCollection::_buildWhereStatements()Builds a where statement out of the setWhere calls
Type | Description |
---|---|
array | with all where statements |


_fetchJoinTables(\none $ignore_root) : array
_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
Name | Type | Description |
---|---|---|
$ignore_root | \none |
Type | Description |
---|---|
array | see above |


_findReverseJoinPartner( $parentclass, $classname) : void
Name | Type | Description |
---|---|---|
$parentclass | ||
$classname |


_initializeDriver( $bForceInit = false) : void
_initializeDriver: Initializes the driver to use with GenericDB.
Inherited from: \ItemCollection::_initializeDriver()\CommunicationCollection::_initializeDriver()Name | Type | Description |
---|---|---|
$bForceInit | boolean If true, forces the driver to initialize, even if it already exists. |


_recursiveStructuredFetch( $objects, $array) : void
Name | Type | Description |
---|---|---|
$objects | ||
$array |


_setItemClass(string $classname) : \none
_setItemClass: private method to set the accompanying item object.
Inherited from: \ItemCollection::_setItemClass()\CommunicationCollection::_setItemClass()Name | Type | Description |
---|---|---|
$classname | string | specifies the classname |
Type | Description |
---|---|
\none |


_setJoinPartner(string $foreignCollectionClass) : \none
_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
Name | Type | Description |
---|---|---|
$foreignCollectionClass | string | Specifies the foreign class to use |
Type | Description |
---|---|
\none |


addResultField( $field) : void
Name | Type | Description |
---|---|---|
$field |


count() : integer
count () Returns the amount of returned items
Inherited from: \ItemCollection::count()\CommunicationCollection::count()Type | Description |
---|---|
integer | Number of rows |


create( $itemtype, $itemid, $reminderdate, $subject, $content, $notimail, $notibackend, $recipient) : void
Creates a new communication item
Name | Type | Description |
---|---|---|
$itemtype | ||
$itemid | ||
$reminderdate | ||
$subject | ||
$content | ||
$notimail | ||
$notibackend | ||
$recipient |


delete( $id) : void
delete() Deletes an item in the table.
Inherited from: \ItemCollection::delete()\CommunicationCollection::delete()Name | Type | Description |
---|---|---|
$id |


deleteWhere( $field, $restriction, $operator = "=") : void
deleteWhere ($field, $restriction, $operator)
Inherited from: \ItemCollection::deleteWhere()\CommunicationCollection::deleteWhere()Restricts a query with a where clause
Name | Type | Description |
---|---|---|
$field | ||
$restriction | ||
$operator |


deleteWhereGroup( $group, $field, $restriction, $operator = "=") : void
deleteWhereGroup ($group, $field, $restriction, $operator)
Inherited from: \ItemCollection::deleteWhereGroup()\CommunicationCollection::deleteWhereGroup()Restricts a query with a where clause, groupable
Name | Type | Description |
---|---|---|
$group | ||
$field | ||
$restriction | ||
$operator |


exists(integer $id) : boolean
exists ($id) Checks if a specific entry exists
Inherited from: \ItemCollection::exists()\CommunicationCollection::exists()Name | Type | Description |
---|---|---|
$id | integer | The id to check for |
Type | Description |
---|---|
boolean | true if object exists, false if not |


fetchArray( $key, $fields) : array
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.
Name | Type | Description |
---|---|---|
$key | string Name of the field to use for the key | |
$fields | mixed String or array |
Type | Description |
---|---|
array | Resulting array |


fetchTable( $fields = array(), $objects = array()) : void
Name | Type | Description |
---|---|---|
$fields | ||
$objects |


flexSelect(string $distinct = "", string $from = "", string $where = "", string $group_by = "", string $order_by = "", string $limit = "") : array
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.
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. |
Type | Description |
---|---|
array | Array of DBObject-Objects |
- Author
- HerrB


link( $foreignClass) : void
sets the query to use foreign tables in the resultset
Inherited from: \ItemCollection::link()\CommunicationCollection::link()Name | Type | Description |
---|---|---|
$foreignClass |


loadItem( $vitem) : object
loadItem ($item) Loads a single object from the database.
Inherited from: \ItemCollection::loadItem()\CommunicationCollection::loadItem()Needs to be overridden by the extension class.
Name | Type | Description |
---|---|---|
$vitem |
Type | Description |
---|---|
object | The newly created object |


next() : object
next () Advances to the next item in the database.
Inherited from: \ItemCollection::next()\CommunicationCollection::next()Type | Description |
---|---|
object | The next object, or false if no more objects |


queryAndFetchStructured(\objects $objects) : array
fetchStructured Returns an array of arrays
Inherited from: \ItemCollection::queryAndFetchStructured()\CommunicationCollection::queryAndFetchStructured()Name | Type | Description |
---|---|---|
$objects | \objects | array with the correct order of the objects |
Type | Description |
---|---|
array | result |


removeResultField( $field) : void
Name | Type | Description |
---|---|---|
$field |


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.
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. |
Type | Description |
---|---|
array | Array of DBObject-Objects |


setGroupCondition( $group1, $group2, $condition = "AND") : void
setGroupCondition ($group1, $group2, $condition)
Inherited from: \ItemCollection::setGroupCondition()\CommunicationCollection::setGroupCondition()Defines how groups are linked to each other
Name | Type | Description |
---|---|---|
$group1 | ||
$group2 | ||
$condition |


setInnerGroupCondition( $group, $condition = "AND") : void
setInnerGroupCondition ($group, $condition)
Inherited from: \ItemCollection::setInnerGroupCondition()\CommunicationCollection::setInnerGroupCondition()Defines how relations in one group are linked each together
Name | Type | Description |
---|---|---|
$group | ||
$condition |


setWhere( $field, $restriction, $operator = "=") : void
setWhere ($field, $restriction, $operator)
Inherited from: \ItemCollection::setWhere()\CommunicationCollection::setWhere()Restricts a query with a where clause
Name | Type | Description |
---|---|---|
$field | ||
$restriction | ||
$operator |


setWhereGroup( $group, $field, $restriction, $operator = "=") : void
setWhereGroup ($group, $field, $restriction, $operator)
Inherited from: \ItemCollection::setWhereGroup()\CommunicationCollection::setWhereGroup()Restricts a query with a where clause, groupable
Name | Type | Description |
---|---|---|
$group | ||
$field | ||
$restriction | ||
$operator |
\TODOItem
- Parent(s)
- \CommunicationItem < \Item
- Author
- Timo A. Hummel
- Copyright
- four for business 2003
- Version
- 0.1
Properties


array $_arrInFilters = array('urlencode', 'conHtmlSpecialChars', 'addslashes')
array('urlencode', 'conHtmlSpecialChars', 'addslashes')
Details- Type
- array
- Access
- private
- Inherited_from
- \Item::$$_arrInFilters
- Inherited_from
- \CommunicationItem::$$_arrInFilters


array $_arrOutFilters = array('stripslashes', 'htmldecode', 'urldecode')
array('stripslashes', 'htmldecode', 'urldecode')
Details- Type
- array
- Access
- private
- Inherited_from
- \Item::$$_arrOutFilters
- Inherited_from
- \CommunicationItem::$$_arrOutFilters


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


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


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


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


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


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


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


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


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


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


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


boolean $virgin
If true, the object is virgin and no operations on it except load-Functions are allowed.
- Type
- boolean
- Access
- private
- Inherited_from
- \Item::$$virgin
- Inherited_from
- \CommunicationItem::$$virgin
Methods


Item(string $table = "", string $primaryKey = "", $lifetime = 10) : void
Name | Type | Description |
---|---|---|
$table | string | The table to use as information source |
$primaryKey | string | The primary key to use |
$lifetime |


_inFilter(mixed $data) : mixed
Filters the passed data using the functions defines in the _arrInFilters array.
Inherited from: \Item::_inFilter()\CommunicationItem::_inFilter()Name | Type | Description |
---|---|---|
$data | mixed | Data to filter |
Type | Description |
---|---|
mixed | Filtered data |
- Access
- private
- See
- \setFilters


_onLoad() : \none
Function which is called whenever an item is loaded. Inherited classes should override this function if desired.
Type | Description |
---|---|
\none |


_outFilter(mixed $data) : mixed
Filters the passed data using the functions defines in the _arrOutFilters array.
Inherited from: \Item::_outFilter()\CommunicationItem::_outFilter()Name | Type | Description |
---|---|---|
$data | mixed | Data to filter |
Type | Description |
---|---|
mixed | Filtered data |
- Access
- private
- See
- \setFilters


deleteProperty(string $type, string $name) : void
deleteProperty ($type, $name) Deletes a custom property
Inherited from: \Item::deleteProperty()\CommunicationItem::deleteProperty()Name | Type | Description |
---|---|---|
$type | string | Specifies the type |
$name | string | Specifies the name |


get(string $field) : mixed
get($field) Wrapper for getField (less to type)
Inherited from: \Item::get()\CommunicationItem::get()Name | Type | Description |
---|---|---|
$field | string | Specifies the field to retrieve |
Type | Description |
---|---|
mixed | Value of the field |


getField(string $field) : mixed
getField($field) Gets the value of a specific field
Inherited from: \Item::getField()\CommunicationItem::getField()Name | Type | Description |
---|---|---|
$field | string | Specifies the field to retrieve |
Type | Description |
---|---|
mixed | Value of the field |


getProperty(string $type, string $name) : boolean
getProperty ($type, $name) Sets a custom property
Inherited from: \Item::getProperty()\CommunicationItem::getProperty()Name | Type | Description |
---|---|---|
$type | string | Specifies the type |
$name | string | Specifies the name |
Type | Description |
---|---|
boolean | Value of the given property |


loadBy(string $field, string $value, bool $bSafe = true) : bool
loadBy ($field, $value) Loads an item by colum/field from the database
Inherited from: \Item::loadBy()\CommunicationItem::loadBy()Name | Type | Description |
---|---|---|
$field | string | Specifies the field |
$value | string | Specifies the value |
$bSafe | bool | use inFilter or not |
Type | Description |
---|---|
bool | True if the load was successful |


loadByPrimaryKey(string $value) : bool
loadByPrimaryKey ($value) Loads an item by ID from the database
Inherited from: \Item::loadByPrimaryKey()\CommunicationItem::loadByPrimaryKey()Name | Type | Description |
---|---|---|
$value | string | Specifies the primary key value |
Type | Description |
---|---|
bool | True if the load was successful |


set(string $field, string $value, $safe = true) : void
set($field, $value) Shortcut to setField
Inherited from: \Item::set()\CommunicationItem::set()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
setField($field, $value) Sets the value of a specific field
Inherited from: \Item::setField()\CommunicationItem::setField()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
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'));
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
Name | Type | Description |
---|---|---|
$type | string | Specifies the type |
$name | string | Specifies the name |
$value | string | Specifies the value |


store() : void
store() Stores the modified user object to the database
Inherited from: \CommunicationItem::store()\TODOLink
- Parent(s)
- \cHTMLLink < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties


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


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


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


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


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


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


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


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


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


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


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


TODOLink( $itemtype, $itemid, $subject, $message) : void
Name | Type | Description |
---|---|---|
$itemtype | ||
$itemid | ||
$subject | ||
$message |


__toString() : string
Direct call of object as string will return it's generated markup.
Inherited from: \cHTML::__toString()\cHTMLLink::__toString()Type | Description |
---|---|
string | Generated markup |


_setContent( $content) : void
_setContent: Sets the content of the object
Inherited from: \cHTML::_setContent()\cHTMLLink::_setContent()Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


advanceID() : void
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
attachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLLink::attachEventDefinition()Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
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
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;"
Name | Type | Description |
---|---|---|
$sName | string Name for a style definition | |
$sDefinition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


cHTML() : void
Constructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLLink::cHTML()

cHTMLLink( $href = "") : void
Creates an HTML link.
Name | Type | Description |
---|---|---|
$href | String with the location to link to |


disableAutomaticParameterAppend() : void


enableAutomaticParameterAppend() : void


fillCloseSkeleton() : string
fillCloseSkeleton: Fills the close skeleton
Inherited from: \cHTML::fillCloseSkeleton()\cHTMLLink::fillCloseSkeleton()Type | Description |
---|---|
string | filled SGML closer skeleton |


fillSkeleton( $attributes) : string
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.
Name | Type | Description |
---|---|---|
$attributes | string Attributes to set |
Type | Description |
---|---|
string | filled SGML opener skeleton |


setAlt( $alt) : void
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.
Name | Type | Description |
---|---|---|
$alt | string Text to set as the "alt" attribute |


setAnchor( $anchor) : void
Only works for the link types Link and cLink.
Name | Type | Description |
---|---|---|
$anchor |


setAttribute( $sAttributeName, $sValue) : void
setAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLLink::setAttribute()Name | Type | Description |
---|---|---|
$sAttributeName | string Name of the attribute | |
$sValue | string Value of the attribute |


setCLink( $targetarea, $targetframe, $targetaction = "") : void
Name | Type | Description |
---|---|---|
$targetarea | string Target backend area | |
$targetframe | string Target frame (1-4) | |
$targetaction | string Target action |


setClass( $class) : void
Name | Type | Description |
---|---|---|
$class | string Text to set as the "alt" attribute |


setContent( $content) : void
Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


setCustom( $key, $value) : void
setCustom: Sets a custom attribute to be appended to the link
Inherited from: \cHTMLLink::setCustom()Name | Type | Description |
---|---|---|
$key | string Parameter name | |
$value | string Parameter value |


setEvent( $event, $action) : void
adds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLLink::setEvent()example: $item->setEvent("change","document.forms[0].submit");
Name | Type | Description |
---|---|---|
$event | string Type of the event | |
$action | string Function or action to call (JavaScript Code) |


setGenerateXHTML(bool $value) : void
Setter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLLink::setGenerateXHTML()Name | Type | Description |
---|---|---|
$value | bool |


setMultiLink( $righttoparea, $righttopaction, $rightbottomarea, $rightbottomaction) : void
Name | Type | Description |
---|---|---|
$righttoparea | string Area (right top) | |
$righttopaction | string Action (right top) | |
$rightbottomarea | string Area (right bottom) | |
$rightbottomaction | string Action (right bottom) |


setStyleDefinition( $entity, $definition) : string
addStyleDefinition
Inherited from: \cHTML::setStyleDefinition()\cHTMLLink::setStyleDefinition()Name | Type | Description |
---|---|---|
$entity | string Entity to define | |
$definition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |