CWIS Developer Documentation
|
Common base class for persistent items store in database. More...
Public Member Functions | |
__construct ($Id) | |
Constructor, used to load existing items. More... | |
Destroy () | |
Destroy item. More... | |
Delete () | |
Destroy item. More... | |
Id () | |
Get item ID. More... | |
Name ($NewValue=DB_NOVALUE) | |
Get/set name of item. More... | |
DateCreated ($NewValue=DB_NOVALUE) | |
Get/set when item was created. More... | |
CreatedBy ($NewValue=DB_NOVALUE) | |
Get/set ID of user who created the item. More... | |
DateLastModified ($NewValue=DB_NOVALUE) | |
Get/set when item was last modified. More... | |
LastModifiedBy ($NewValue=DB_NOVALUE) | |
Get/set ID of user who last modified the item. More... | |
Static Public Member Functions | |
static | GetCanonicalId ($Id) |
Normalize item ID to canonical form. More... | |
static | ItemExists ($Id) |
Check whether an item exists with the specified ID. More... | |
Protected Member Functions | |
UpdateValue ($ColumnName, $NewValue=DB_NOVALUE) | |
Convenience function to supply parameters to Database::UpdateValue(). More... | |
UpdateDateValue ($ColumnName, $NewValue=DB_NOVALUE) | |
Convenience function to supply parameters to Database::UpdateValue(), with preprocessing of new values to convert them into an SQL-compatible date format. More... | |
Static Protected Member Functions | |
static | CreateWithValues ($Values) |
Create a new item, using specified initial database values. More... | |
static | SetDatabaseAccessValues ($ClassName) |
Set the database access values (table name, ID column name, name column name) for specified class. More... | |
Protected Attributes | |
$DB | |
$Id | |
$ItemIdColumnName | |
$ItemNameColumnName | |
$ItemTableName | |
$ValueCache = array() | |
Static Protected Attributes | |
static | $ItemIdColumnNames |
static | $ItemNameColumnNames |
static | $ItemTableNames |
Item::__construct | ( | $Id | ) |
Constructor, used to load existing items.
To create new items, child classes should implement a static Create() method.
mixed | $Id | ID of item to load, in a form resolvable by GetCanonicalId(). |
InvalidArgumentException | If ID is invalid. |
Item::CreatedBy | ( | $NewValue = DB_NOVALUE | ) |
Get/set ID of user who created the item.
(This method assumes there is a "CreatedBy" column in the database of type INT.)
int | $NewValue | New user ID. |
Definition at line 121 of file Item.php.
References UpdateValue().
|
staticprotected |
Item::DateCreated | ( | $NewValue = DB_NOVALUE | ) |
Get/set when item was created.
(This method assumes there is a "DateCreated" column in the database of type DATETIME.)
string | $NewValue | New creation date. |
Definition at line 110 of file Item.php.
References UpdateDateValue().
Item::DateLastModified | ( | $NewValue = DB_NOVALUE | ) |
Get/set when item was last modified.
(This method assumes there is a "DateLastModified" column in the database of type DATETIME.)
string | $NewValue | New modification date. |
Definition at line 132 of file Item.php.
References UpdateDateValue().
Item::Delete | ( | ) |
Item::Destroy | ( | ) |
|
static |
Item::Id | ( | ) |
Get item ID.
Definition at line 78 of file Item.php.
References $Id.
Referenced by __construct(), Destroy(), and UpdateValue().
|
static |
Check whether an item exists with the specified ID.
This only checks whether there is an entry for an item with the specified ID in the database – it does not check anything else (e.g. the type of the item).
int | $Id | ID to check. |
Definition at line 155 of file Item.php.
Referenced by ResourceFactory\DuplicateResource(), and ResourceFactory\FilterNonViewableResources().
Item::LastModifiedBy | ( | $NewValue = DB_NOVALUE | ) |
Get/set ID of user who last modified the item.
(This method assumes there is a "LastModifiedBy" column in the database of type INT.)
int | $NewValue | New user ID. |
Definition at line 143 of file Item.php.
References UpdateValue().
Item::Name | ( | $NewValue = DB_NOVALUE | ) |
Get/set name of item.
(This method assumes there is a "Name" column in the database of type TEXT.)
string | $NewValue | New name. (OPTIONAL) |
Definition at line 99 of file Item.php.
References UpdateValue().
|
staticprotected |
Set the database access values (table name, ID column name, name column name) for specified class.
This may be overridden in a child class, if different values are needed.
string | $ClassName | Class to set values for. |
Definition at line 238 of file Item.php.
References StdLib\Pluralize().
|
protected |
Convenience function to supply parameters to Database::UpdateValue(), with preprocessing of new values to convert them into an SQL-compatible date format.
string | $ColumnName | Name of database column. |
string | $NewValue | New value for field. (OPTIONAL) |
Definition at line 271 of file Item.php.
References DB_NOVALUE, and UpdateValue().
Referenced by DateCreated(), and DateLastModified().
|
protected |
Convenience function to supply parameters to Database::UpdateValue().
string | $ColumnName | Name of database column. |
string | $NewValue | New value for field. (OPTIONAL) |
Definition at line 255 of file Item.php.
References Id().
Referenced by CreatedBy(), Classification\FieldId(), LastModifiedBy(), Classification\LinkString(), Name(), Classification\QualifierId(), Classification\RecalcDepthAndFullName(), Classification\RecalcResourceCount(), Classification\SegmentName(), and UpdateDateValue().
|
protected |
Definition at line 181 of file Item.php.
Referenced by Resource\Classifications(), Resource\Clear(), Classification\Create(), Resource\Create(), CreateWithValues(), Resource\Delete(), Resource\GetSchemaForResource(), Resource\IsTempResource(), ItemExists(), Resource\Rating(), and Resource\Set().
|
protected |
Definition at line 182 of file Item.php.
Referenced by __construct(), Resource\Clear(), Resource\Create(), GetCanonicalId(), Id(), Classification\Id(), Resource\Id(), Resource\IsTempResource(), ItemExists(), Classification\RecalcResourceCount(), and Resource\Set().