WireDataDB class

Located in file /wire/core/WireDataDB.php

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.

Common

Name	Return	Summary
WireDataDB::copyTo() WireDataDB::copyTo(int $newSourceID) WireDataDB::copyTo(int $newSourceID)	`int`	Copy all data to a new source ID
WireDataDB::count() WireDataDB::count() WireDataDB::count()	`int`	Count the number of rows this WireDataDB maintains in the database for source ID.
WireDataDB::get() WireDataDB::get(string $key) WireDataDB::get(string $key)	`array` `mixed` `null`	Get the value for a specific property/name/key
WireDataDB::getArray() WireDataDB::getArray() WireDataDB::getArray()	`array` `mixed` `null`	Get all values in an associative array
WireDataDB::getIterator() WireDataDB::getIterator() WireDataDB::getIterator()	`ArrayObject`	Enables the object data properties to be iterable as an array
WireDataDB::install() WireDataDB::install() WireDataDB::install()	`bool`	Install the table
WireDataDB::remove() WireDataDB::remove(string $key) WireDataDB::remove(string $key)	`self`	Remove value for a specific property/name/key
WireDataDB::removeAll() WireDataDB::removeAll() WireDataDB::removeAll()	`$this`	Remove all values for sourceID from the DB
WireDataDB::reset() WireDataDB::reset() WireDataDB::reset()	`$this`	Reset all loaded data so that it will re-load from DB on next access
WireDataDB::set() WireDataDB::set(string $key, mixed $value) WireDataDB::set(string $key, mixed $value)	`self`	Set and save a value for a specific property/name/key
WireDataDB::sourceID() WireDataDB::sourceID() WireDataDB::sourceID($id = null)	`int`	Get or set the the source ID for this instance
WireDataDB::table() WireDataDB::table() WireDataDB::table(string $tableName = '')	`string`	Get the current table name
WireDataDB::uninstall() WireDataDB::uninstall() WireDataDB::uninstall()	`bool`	Uninstall 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.228

Located in file /wire/core/WireDataDB.php

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news