WireDataDB class

WireData with database storage

A WireData object that maintains its data in a database table rather than just in memory. An example of usage is the $page->meta() method.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireDataDB class also inherits all the methods and properties of: WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
WireDataDB::copyTo(int $newSourceID)
intCopy all data to a new source ID 
WireDataDB::count()
intCount the number of rows this WireDataDB maintains in the database for source ID. 
WireDataDB::get(string $key)
array mixed nullGet the value for a specific property/name/key 
WireDataDB::getArray()
array mixed nullGet all values in an associative array 
WireDataDB::getIterator()
None 
WireDataDB::install()
boolInstall the table 
WireDataDB::remove(string $key)
selfRemove value for a specific property/name/key 
WireDataDB::removeAll()
$thisRemove all values for sourceID from the DB 
WireDataDB::reset()
$thisReset all loaded data so that it will re-load from DB on next access 
WireDataDB::set(string $key, mixed $value)
selfSet and save a value for a specific property/name/key 
WireDataDB::sourceID()
intGet or set the the source ID for this instance 
WireDataDB::table()
stringGet the current table name 
WireDataDB::uninstall()
boolUninstall the table 

Additional methods and properties

In addition to the methods and properties above, WireDataDB also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251