Class TableDate

TableAccess

TableDate

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

TableDate Diese Klasse dient dazu ein Terminobjekt zu erstellen. Ein Termin kann ueber diese Klasse in der Datenbank verwaltet werden

Beside the methods of the parent class there are the following additional methods:

getIcal($domain) - gibt String mit dem Termin im iCal-Format zurueck editRight() - prueft, ob der Termin von der aktuellen Orga bearbeitet werden darf

Located at tabledate.php

Methods summary

`public`	# `__construct( Database & $database, integer $dat_id = 0 )` Constructor that will create an object of a recordset of the table adm_dates. If the id is set than the specific date will be loaded. Constructor that will create an object of a recordset of the table adm_dates. If the id is set than the specific date will be loaded. Parameters `$database` Object of the class Database. This should be the default global object @b $gDb. `$dat_id` The recordset of the date with this id will be loaded. If id isn't set than an empty object of the table is created. Overrides `TableAccess::__construct`
`public`	# `clear( )` Additional to the parent method visible roles array and flag will be initialized. Additional to the parent method visible roles array and flag will be initialized. Overrides `TableAccess::clear`
`public boolean`	# `delete( )` Deletes the selected record of the table and all references in other tables. After that the class will be initialize. Deletes the selected record of the table and all references in other tables. After that the class will be initialize. Returns boolean @b true if no error occurred Overrides `TableAccess::delete`
`public boolean`	# `editRight( )` prueft, ob der Termin von der aktuellen Orga bearbeitet werden darf prueft, ob der Termin von der aktuellen Orga bearbeitet werden darf Returns boolean
`public string`	# `getIcal( string $domain )` gibt einen Termin im iCal-Format zurueck gibt einen Termin im iCal-Format zurueck Parameters `$domain` Returns string
`public string`	# `getIcalHeader( )` gibt den Kopf eines iCalCalenders aus gibt den Kopf eines iCalCalenders aus Returns string
`public string`	# `getIcalFooter( )` gibt den Fuß eines iCalCalenders aus gibt den Fuß eines iCalCalenders aus Returns string
`public string`	# `getIcalVEvent( string $domain )` gibt einen einzelnen Termin im iCal-Format zurück gibt einen einzelnen Termin im iCal-Format zurück Parameters `$domain` Returns string
`public integer\|string\|boolean`	# `getValue( string $columnName, string $format = '' )` Get the value of a column of the database table. If the value was manipulated before with @b setValue than the manipulated value is returned. Get the value of a column of the database table. If the value was manipulated before with @b setValue than the manipulated value is returned. Parameters `$columnName` The name of the database column whose value should be read `$format` For date or timestamp columns the format should be the date/time format e.g. @b d.m.Y = '02.04.2011'. @n For text columns the format can be @b database that would return the original database value without any transformations Returns integer\|string\|boolean Returns the value of the database column. If the value was manipulated before with @b setValue than the manipulated value is returned. Overrides `TableAccess::getValue`
`public array`	# `getVisibleRoles( )` die Methode gibt ein Array mit den fuer den Termin sichtbaren Rollen-IDs zurueck die Methode gibt ein Array mit den fuer den Termin sichtbaren Rollen-IDs zurueck Returns array
`public boolean`	# `save( boolean $updateFingerPrint = true )` Save all changed columns of the recordset in table of database. Therefore the class remembers if it's a new record or if only an update is necessary. The update statement will only update the changed columns. If the table has columns for creator or editor than these column with their timestamp will be updated. Saves also all roles that could see this date. Save all changed columns of the recordset in table of database. Therefore the class remembers if it's a new record or if only an update is necessary. The update statement will only update the changed columns. If the table has columns for creator or editor than these column with their timestamp will be updated. Saves also all roles that could see this date. Parameters `$updateFingerPrint` Default @b true. Will update the creator or editor of the recordset if table has columns like @b usr_id_create or @b usr_id_changed Returns boolean Overrides `TableAccess::save`
`public boolean`	# `setValue( string $columnName, mixed $newValue, boolean $checkValue = true )` Set a new value for a column of the database table. The value is only saved in the object. You must call the method @b save to store the new value to the database Set a new value for a column of the database table. The value is only saved in the object. You must call the method @b save to store the new value to the database Parameters `$columnName` The name of the database column whose value should get a new value `$newValue` The new value that should be stored in the database field `$checkValue` The value will be checked if it's valid. If set to @b false than the value will not be checked. Returns boolean Returns @b true if the value is stored in the current object and @b false if a check failed Overrides `TableAccess::setValue`
`public`	# `setVisibleRoles( array $arrVisibleRoleIds )` die Methode erwartet ein Array mit den fuer den Termin sichtbaren Rollen-IDs die Methode erwartet ein Array mit den fuer den Termin sichtbaren Rollen-IDs Parameters `$arrVisibleRoleIds`

Methods inherited from TableAccess

__sleep(), connectAdditionalTable(), countAllRecords(), hasColumnsValueChanged(), isNewRecord(), readData(), readDataByColumns(), readDataById(), setArray(), setDatabase()

Properties summary

`protected array`	`$visibleRoles`	# `array()`
`protected`	`$changeVisibleRoles`	#

Properties inherited from TableAccess

$additionalTables, $columnPrefix, $columnsInfos, $columnsValueChanged, $db, $dbColumns, $keyColumnName, $new_record, $tableName

Packages

Classes

Exceptions

Functions

Class TableDate

Methods summary

Parameters

Overrides

Overrides

Returns

Overrides

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Methods inherited from TableAccess

Properties summary

Properties inherited from TableAccess