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.

Show class?             Show args?        

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()
ArrayObjectEnables the object data properties to be iterable as an array 
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.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.