contenido\classes\class.note.php

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

Description: Contenido Notes 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, Dominik Ziegler, add security fix $Id: class.note.php 531 2008-07-02 13:30:54Z frederic.schneider $: }}  
Version
1.0.6  

\NoteCollection

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

>VPropertypublicarray $_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  
>VPropertypublicstring $_encoding
Details
Type
string
Access
private  
Inherited_from
\ItemCollection::$$_encoding  
Inherited_from
\CommunicationCollection::$$_encoding  
>VPropertypublicarray $_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  
>VPropertypublicarray $_groupConditions
Details
Type
array
Access
private  
Inherited_from
\ItemCollection::$$_groupConditions  
Inherited_from
\CommunicationCollection::$$_groupConditions  
>VPropertypublicarray $_innerGroupConditions = array()
Default valuearray()Details
Type
array
Access
private  
Inherited_from
\ItemCollection::$$_innerGroupConditions  
Inherited_from
\CommunicationCollection::$$_innerGroupConditions  
>VPropertypublicstring $_itemClass
Details
Type
string
Access
private  
Inherited_from
\ItemCollection::$$_itemClass  
Inherited_from
\CommunicationCollection::$$_itemClass  
>VPropertypublicobject $_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  
>VPropertypublicarray $_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  
>VPropertypublicarray $_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  
>VPropertypublicarray $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  
>VPropertypublicobject $db
inherited
DB_Contenido instance
Inherited from: \ItemCollection::$$db\CommunicationCollection::$$db
Details
Type
object
Access
private  
Inherited_from
\ItemCollection::$$db  
Inherited_from
\CommunicationCollection::$$db  
>VPropertypublicstring $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  
>VPropertypublicint $lifetime
inherited

Lifetime in seconds

Inherited from: \ItemCollection::$$lifetime\CommunicationCollection::$$lifetime
Details
Type
int
Access
private  
Inherited_from
\ItemCollection::$$lifetime  
Inherited_from
\CommunicationCollection::$$lifetime  
>VPropertypublicstring $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  
>VPropertypublicstring $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  
>VPropertypublicarray $properties
Details
Type
array
Access
private  
Inherited_from
\ItemCollection::$$properties  
Inherited_from
\CommunicationCollection::$$properties  
>VPropertypublicstring $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  
>VPropertypublicarray $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

methodpublicCommunicationCollection() : void
inherited

Constructor Function

Inherited from: \CommunicationCollection::CommunicationCollection()
methodpublicItemCollection(string $table,  $primaryKey,  $lifetime = 10) : void
inherited

Constructor Function Note: Default lifetime is 10 seconds.

Inherited from: \ItemCollection::ItemCollection()\CommunicationCollection::ItemCollection()
Parameters
NameTypeDescription
$tablestring

The table to use as information source

$primaryKey
$lifetime
methodpublicNoteCollection() : void

methodpublic_buildGroupWhereStatements() : array

Builds a where statement out of the setGroupWhere calls

Returns
TypeDescription
arraywith all where statements
methodpublic_buildWhereStatements() : array

Builds a where statement out of the setWhere calls

Returns
TypeDescription
arraywith all where statements
methodpublic_fetchJoinTables(\none $ignore_root) : array

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
NameTypeDescription
$ignore_root\none
Returns
TypeDescription
arraysee above
methodpublic_findReverseJoinPartner( $parentclass,  $classname) : void
Parameters
NameTypeDescription
$parentclass
$classname
methodpublic_initializeDriver( $bForceInit = false) : void
inherited

_initializeDriver: Initializes the driver to use with GenericDB.

Inherited from: \ItemCollection::_initializeDriver()\CommunicationCollection::_initializeDriver()
Parameters
NameTypeDescription
$bForceInit

boolean If true, forces the driver to initialize, even if it already exists.

methodpublic_recursiveStructuredFetch( $objects,  $array) : void
Parameters
NameTypeDescription
$objects
$array
methodpublic_setItemClass(string $classname) : \none
inherited

_setItemClass: private method to set the accompanying item object.

Inherited from: \ItemCollection::_setItemClass()\CommunicationCollection::_setItemClass()
Parameters
NameTypeDescription
$classnamestring

specifies the classname

Returns
TypeDescription
\none
methodpublic_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
NameTypeDescription
$foreignCollectionClassstring

Specifies the foreign class to use

Returns
TypeDescription
\none
methodpublicaddResultField( $field) : void
Parameters
NameTypeDescription
$field
methodpubliccount() : integer
inherited

count () Returns the amount of returned items

Inherited from: \ItemCollection::count()\CommunicationCollection::count()
Returns
TypeDescription
integerNumber of rows
methodpubliccreate( $itemtype,  $itemid,  $idlang,  $message,  $category = "") : object

create: Creates a new note item.

Parameters
NameTypeDescription
$itemtype

string Item type (usually the class name)

$itemid

mixed Item ID (usually the primary key)

$idlang

int Language-ID

$message

string Message to store

$category
Returns
TypeDescription
objectThe new item
Details
Access
public  
methodpublicdelete( $id) : void
inherited

delete() Deletes an item in the table.

Inherited from: \ItemCollection::delete()\CommunicationCollection::delete()
Parameters
NameTypeDescription
$id
methodpublicdeleteWhere( $field,  $restriction,  $operator = "=") : void
inherited

deleteWhere ($field, $restriction, $operator)

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

Restricts a query with a where clause

Parameters
NameTypeDescription
$field
$restriction
$operator
methodpublicdeleteWhereGroup( $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
NameTypeDescription
$group
$field
$restriction
$operator
methodpublicexists(integer $id) : boolean
inherited

exists ($id) Checks if a specific entry exists

Inherited from: \ItemCollection::exists()\CommunicationCollection::exists()
Parameters
NameTypeDescription
$idinteger

The id to check for

Returns
TypeDescription
booleantrue if object exists, false if not
methodpublicfetchArray( $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
NameTypeDescription
$key

string Name of the field to use for the key

$fields

mixed String or array

Returns
TypeDescription
arrayResulting array
methodpublicfetchObject( $class) : void
Parameters
NameTypeDescription
$class
methodpublicfetchTable( $fields = array(),  $objects = array()) : void
Parameters
NameTypeDescription
$fields
$objects
methodpublicflexSelect(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
NameTypeDescription
$distinctstring

Specifies if distinct will be added to the SQL statement ($distinct !== "" -> DISTINCT)

$fromstring

Specifies the additional from clause (e.g. "con_news_groups AS groups, con_news_groupmembers AS groupmembers").

$wherestring

Specifies the where clause.

$group_bystring

Specifies the group by clause.

$order_bystring

Specifies the order by clause.

$limitstring

Specifies the limit by clause.

Returns
TypeDescription
arrayArray of DBObject-Objects
Details
Author
HerrB  
methodpubliclink( $foreignClass) : void
inherited

sets the query to use foreign tables in the resultset

Inherited from: \ItemCollection::link()\CommunicationCollection::link()
Parameters
NameTypeDescription
$foreignClass
methodpublicloadItem( $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
NameTypeDescription
$vitem
Returns
TypeDescription
objectThe newly created object
methodpublicnext() : object
inherited

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

Inherited from: \ItemCollection::next()\CommunicationCollection::next()
Returns
TypeDescription
objectThe next object, or false if no more objects
methodpublicquery() : void
methodpublicqueryAndFetchStructured(\objects $objects) : array
inherited

fetchStructured Returns an array of arrays

Inherited from: \ItemCollection::queryAndFetchStructured()\CommunicationCollection::queryAndFetchStructured()
Parameters
NameTypeDescription
$objects\objects

array with the correct order of the objects

Returns
TypeDescription
arrayresult
methodpublicremoveResultField( $field) : void
Parameters
NameTypeDescription
$field
methodpublicselect(string $where = "", string $group_by = "", string $order_by = "", string $limit = "") : array

select: Selects one or more items from the database

This function only extends the where statement. See the original function for the parameters.

Parameters
NameTypeDescription
$wherestring

Specifies the where clause.

$group_bystring

Specifies the group by clause.

$order_bystring

Specifies the order by clause.

$limitstring

Specifies the limit by clause.

Returns
TypeDescription
arrayArray of DBObject-Objects
Details
Access
public  
See
\ItemCollection  
methodpublicsetEncoding( $sEncoding) : void
Parameters
NameTypeDescription
$sEncoding
methodpublicsetGroupCondition( $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
NameTypeDescription
$group1
$group2
$condition
methodpublicsetInnerGroupCondition( $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
NameTypeDescription
$group
$condition
methodpublicsetLimit( $iRowStart,  $iRowCount) : void
Parameters
NameTypeDescription
$iRowStart
$iRowCount
methodpublicsetOrder( $order) : void
Parameters
NameTypeDescription
$order
methodpublicsetWhere( $field,  $restriction,  $operator = "=") : void
inherited

setWhere ($field, $restriction, $operator)

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

Restricts a query with a where clause

Parameters
NameTypeDescription
$field
$restriction
$operator
methodpublicsetWhereGroup( $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
NameTypeDescription
$group
$field
$restriction
$operator

\NoteItem

Package: Default
Single CommunicationItem Item
Parent(s)
\CommunicationItem < \Item
Author
Timo A. Hummel  
Copyright
four for business 2003  
Version
0.1  

Properties

>VPropertypublicarray $_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  
>VPropertypublicarray $_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  
>VPropertypublic$_metaObject
Details
Type
n/a
Inherited_from
\Item::$$_metaObject  
Inherited_from
\CommunicationItem::$$_metaObject  
>VPropertypublicarray $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  
>VPropertypublicobject $db
inherited
DB_Contenido instance
Inherited from: \Item::$$db\CommunicationItem::$$db
Details
Type
object
Access
private  
Inherited_from
\Item::$$db  
Inherited_from
\CommunicationItem::$$db  
>VPropertypublicstring $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  
>VPropertypublicint $lifetime
inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime\CommunicationItem::$$lifetime
Details
Type
int
Access
private  
Inherited_from
\Item::$$lifetime  
Inherited_from
\CommunicationItem::$$lifetime  
>VPropertypublicarray $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  
>VPropertypublicstring $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  
>VPropertypublicobject $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  
>VPropertypublicobject $properties
inherited

PropertyCollection object

Inherited from: \Item::$$properties\CommunicationItem::$$properties
Details
Type
object
Access
private  
Inherited_from
\Item::$$properties  
Inherited_from
\CommunicationItem::$$properties  
>VPropertypublicstring $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  
>VPropertypublicarray $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  
>VPropertypublicboolean $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

methodpublicCommunicationItem() : void
inherited

Constructor Function

Inherited from: \CommunicationItem::CommunicationItem()
methodpublicItem(string $table = "", string $primaryKey = "",  $lifetime = 10) : void
inherited

Constructor Function

Inherited from: \Item::Item()\CommunicationItem::Item()
Parameters
NameTypeDescription
$tablestring

The table to use as information source

$primaryKeystring

The primary key to use

$lifetime
methodpublic_inFilter(mixed $data) : mixed
inherited

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

Inherited from: \Item::_inFilter()\CommunicationItem::_inFilter()
Parameters
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_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
TypeDescription
\none
methodpublic_outFilter(mixed $data) : mixed
inherited

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

Inherited from: \Item::_outFilter()\CommunicationItem::_outFilter()
Parameters
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_setMetaObject( $objectname) : void
Parameters
NameTypeDescription
$objectname
methodpublicdeleteProperty(string $type, string $name) : void
inherited

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

Inherited from: \Item::deleteProperty()\CommunicationItem::deleteProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

methodpublicget(string $field) : mixed
inherited

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

Inherited from: \Item::get()\CommunicationItem::get()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetField(string $field) : mixed
inherited

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

Inherited from: \Item::getField()\CommunicationItem::getField()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetMetaObject() : void
methodpublicgetProperty(string $type, string $name) : boolean
inherited

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

Inherited from: \Item::getProperty()\CommunicationItem::getProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

Returns
TypeDescription
booleanValue of the given property
methodpublicloadBy(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
NameTypeDescription
$fieldstring

Specifies the field

$valuestring

Specifies the value

$bSafebool

use inFilter or not

Returns
TypeDescription
boolTrue if the load was successful
methodpublicloadByPrimaryKey(string $value) : bool
inherited

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

Inherited from: \Item::loadByPrimaryKey()\CommunicationItem::loadByPrimaryKey()
Parameters
NameTypeDescription
$valuestring

Specifies the primary key value

Returns
TypeDescription
boolTrue if the load was successful
methodpublicset(string $field, string $value,  $safe = true) : void
inherited

set($field, $value) Shortcut to setField

Inherited from: \Item::set()\CommunicationItem::set()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safe
methodpublicsetField(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
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safeboolean

Speficies if we should translate characters

methodpublicsetFilters(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
NameTypeDescription
$arrInFiltersarray

inFilters array with function names

$arrOutFiltersarray

outFilters array with function names

methodpublicsetProperty(string $type, string $name, string $value) : void
inherited

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

Inherited from: \Item::setProperty()\CommunicationItem::setProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

$valuestring

Specifies the value

methodpublicstore() : void
inherited

store() Stores the modified user object to the database

Inherited from: \CommunicationItem::store()

\NoteLink

Package: Default
HTML Link
Parent(s)
\cHTMLLink < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_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  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cHTMLLink::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLLink::$$_aStyleDefinitions  
>VPropertypublic$_anchor
inheritedInherited from: \cHTMLLink::$$_anchor
Details
Type
n/a
Inherited_from
\cHTMLLink::$$_anchor  
>VPropertypublicboolean $_bDeleteHistoryItems

If true, history items can be deleted

Details
Type
boolean
Access
private  
>VPropertypublicboolean $_bShowHistory

If true, shows the note history

Details
Type
boolean
Access
private  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTMLLink::$$_content
Details
Type
n/a
Inherited_from
\cHTMLLink::$$_content  
>VPropertypublicboolean $_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  
>VPropertypublic$_custom
inheritedInherited from: \cHTMLLink::$$_custom
Details
Type
n/a
Inherited_from
\cHTMLLink::$$_custom  
>VPropertypublic$_link
inheritedInherited from: \cHTMLLink::$$_link
Details
Type
n/a
Inherited_from
\cHTMLLink::$$_link  
>VPropertypublicarray $_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  
>VPropertypublicstring $_sItemID

Object ID

Details
Type
string
Access
private  
>VPropertypublicstring $_sItemType

Object type

Details
Type
string
Access
private  
>VPropertypublicstring $_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  
>VPropertypublicstring $_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  
>VPropertypublicstring $_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  
>VPropertypublicstring $_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  
>VPropertypublicstring $_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

methodpublicNoteLink( $sItemType,  $sItemID) : \none

NoteLink: Creates a new note link item.

This link is used to show the popup from any position within the system. The link contains the note image.

Parameters
NameTypeDescription
$sItemType

string Item type (usually the class name)

$sItemID
Returns
TypeDescription
\none
Details
Access
public  
methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLLink::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLLink::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : 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.

methodpublicattachEventDefinition( $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
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLLink::cHTML()
methodpubliccHTMLLink( $href = "") : void
inherited

Constructor.

Inherited from: \cHTMLLink::cHTMLLink()

Creates an HTML link.

Parameters
NameTypeDescription
$href

String with the location to link to

methodpublicdisableAutomaticParameterAppend() : void
methodpublicdisableHistory() : \none

disableHistory: Disables the display of all note items

Returns
TypeDescription
\none
Details
Access
public  
methodpublicdisableHistoryDelete() : \none

disableHistoryDelete: Disables the delete function in the history view

Returns
TypeDescription
\none
Details
Access
public  
methodpublicenableAutomaticParameterAppend() : void
methodpublicenableHistory() : \none

enableHistory: Enables the display of all note items

Returns
TypeDescription
\none
Details
Access
public  
methodpublicenableHistoryDelete() : \none

enableHistoryDelete: Enables the delete function in the history view

Returns
TypeDescription
\none
Details
Access
public  
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLLink::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $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
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetHref() : void
inherited

Inherited from: \cHTMLLink::getHref()
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLLink::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender( $return = false) : \none

render: Renders the resulting link

Parameters
NameTypeDescription
$return
Returns
TypeDescription
\none
Details
Access
public  
methodpublicsetAlt( $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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAnchor( $anchor) : void
inherited

setAnchor: Sets an anchor

Inherited from: \cHTMLLink::setAnchor()

Only works for the link types Link and cLink.

Parameters
NameTypeDescription
$anchor
methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLLink::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetCLink( $targetarea,  $targetframe,  $targetaction = "") : void
inherited

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

Inherited from: \cHTMLLink::setCLink()
Parameters
NameTypeDescription
$targetarea

string Target backend area

$targetframe

string Target frame (1-4)

$targetaction

string Target action

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLLink::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

setContent: Sets the link's content

Inherited from: \cHTMLLink::setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetCustom( $key,  $value) : void
inherited

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

Inherited from: \cHTMLLink::setCustom()
Parameters
NameTypeDescription
$key

string Parameter name

$value

string Parameter value

methodpublicsetEvent( $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
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLLink::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLLink::setID()
Parameters
NameTypeDescription
$id
methodpublicsetLink( $href) : void
inherited

setLink: Sets the link to a specific location

Inherited from: \cHTMLLink::setLink()
Parameters
NameTypeDescription
$href

String with the location to link to

methodpublicsetMultiLink( $righttoparea,  $righttopaction,  $rightbottomarea,  $rightbottomaction) : void
inherited

setMultiLink: Sets a multilink

Inherited from: \cHTMLLink::setMultiLink()
Parameters
NameTypeDescription
$righttoparea

string Area (right top)

$righttopaction

string Action (right top)

$rightbottomarea

string Area (right bottom)

$rightbottomaction

string Action (right bottom)

methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLLink::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLLink::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTargetFrame( $target) : void
inherited

setTargetFrame: Sets the target frame

Inherited from: \cHTMLLink::setTargetFrame()
Parameters
NameTypeDescription
$target

string Target frame identifier

methodpublictoHTML() : string
inherited

Renders the link

Inherited from: \cHTMLLink::toHTML()
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\NoteList

Package: Default
Div Element
Parent(s)
\cHTMLDiv < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLDiv::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLDiv::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cHTMLDiv::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLDiv::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLDiv::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLDiv::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLDiv::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLDiv::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLDiv::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLDiv::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLDiv::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLDiv::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLDiv::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLDiv::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLDiv::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLDiv::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLDiv::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLDiv::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLDiv::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLDiv::$$_tag  

Methods

methodpublicNoteList( $sItemType,  $sItemId) : void

Parameters
NameTypeDescription
$sItemType
$sItemId
methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLDiv::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLDiv::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLDiv::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLDiv::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLDiv::cHTML()
methodpubliccHTMLDiv( $content = "") : void
inherited

Constructor.

Inherited from: \cHTMLDiv::cHTMLDiv()

Creates an HTML DIV element.

Parameters
NameTypeDescription
$content

mixed String or object with the contents

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLDiv::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLDiv::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLDiv::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLDiv::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLDiv::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLDiv::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

setContent: Sets the div's content

Inherited from: \cHTMLDiv::setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDeleteable( $bDeleteable) : void

Parameters
NameTypeDescription
$bDeleteable
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLDiv::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLDiv::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLDiv::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLDiv::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the DIV element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\NoteListItem

Package: Default
Div Element
Parent(s)
\cHTMLDiv < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLDiv::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLDiv::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cHTMLDiv::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLDiv::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLDiv::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLDiv::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLDiv::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLDiv::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLDiv::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLDiv::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLDiv::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLDiv::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLDiv::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLDiv::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLDiv::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLDiv::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLDiv::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLDiv::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLDiv::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLDiv::$$_tag  

Methods

methodpublicNoteListItem( $sItemType,  $sItemId,  $iDeleteItem) : void

Parameters
NameTypeDescription
$sItemType
$sItemId
$iDeleteItem
methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLDiv::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLDiv::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLDiv::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLDiv::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLDiv::cHTML()
methodpubliccHTMLDiv( $content = "") : void
inherited

Constructor.

Inherited from: \cHTMLDiv::cHTMLDiv()

Creates an HTML DIV element.

Parameters
NameTypeDescription
$content

mixed String or object with the contents

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLDiv::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLDiv::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string

render(): Alias for toHtml

Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLDiv::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLDiv::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetAuthor( $sAuthor) : void

Parameters
NameTypeDescription
$sAuthor
methodpublicsetBackground( $dark = false) : void

Parameters
NameTypeDescription
$dark
methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLDiv::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

setContent: Sets the div's content

Inherited from: \cHTMLDiv::setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDate( $iDate) : void

Parameters
NameTypeDescription
$iDate
methodpublicsetDeleteable( $bDeleteable) : void

Parameters
NameTypeDescription
$bDeleteable
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLDiv::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLDiv::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMessage( $sMessage) : void

Parameters
NameTypeDescription
$sMessage
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLDiv::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLDiv::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string
inherited

Renders the DIV element

Inherited from: \cHTMLDiv::toHTML()
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\NoteView

Package: Default
IFrame element
Parent(s)
\cHTMLIFrame < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLIFrame::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLIFrame::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cHTMLIFrame::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLIFrame::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLIFrame::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLIFrame::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLIFrame::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLIFrame::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLIFrame::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLIFrame::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLIFrame::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLIFrame::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLIFrame::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLIFrame::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLIFrame::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLIFrame::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLIFrame::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLIFrame::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLIFrame::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLIFrame::$$_tag  

Methods

methodpublicNoteView( $sItemType,  $sItemId) : void

Parameters
NameTypeDescription
$sItemType
$sItemId
methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLIFrame::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLIFrame::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLIFrame::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLIFrame::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLIFrame::cHTML()
methodpubliccHTMLIFrame() : void
inherited

Inherited from: \cHTMLIFrame::cHTMLIFrame()
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLIFrame::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLIFrame::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLIFrame::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLIFrame::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLIFrame::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBorder( $border) : void
inherited

setBorder: Sets wether this iframe should have a border or not

Inherited from: \cHTMLIFrame::setBorder()
Parameters
NameTypeDescription
$border

If 1 or true, this frame will have a border

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLIFrame::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLIFrame::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetHeight( $height) : void
inherited

setHeight: Sets this frame's height

Inherited from: \cHTMLIFrame::setHeight()
Parameters
NameTypeDescription
$height

Height of the item

methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLIFrame::setID()
Parameters
NameTypeDescription
$id
methodpublicsetSrc( $src) : void
inherited

setSrc: Sets this frame's source

Inherited from: \cHTMLIFrame::setSrc()
Parameters
NameTypeDescription
$src
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLIFrame::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLIFrame::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetWidth( $width) : void
inherited

setWidth: Sets this frame's width

Inherited from: \cHTMLIFrame::setWidth()
Parameters
NameTypeDescription
$width

Width of the item

methodpublictoHTML() : string
inherited

Renders the table head element

Inherited from: \cHTMLIFrame::toHTML()
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

Documentation was generated by phpDocumentor 2.0.0a12.