class DatabaseStatementBase

Default implementation of DatabaseStatementInterface.

PDO allows us to extend the PDOStatement class to provide additional functionality beyond that offered by default. We do need extra functionality. By default, this class is not driver-specific. If a given driver needs to set a custom statement class, it may do so in its constructor.

Hierarchy

Expanded class hierarchy of DatabaseStatementBase

See also

http://us.php.net/pdostatement

Related topics

Database abstraction layer
Allow the use of different database servers using the same code base.

File

includes/database/database.inc, line 2249

View source 
class DatabaseStatementBase extends PDOStatement implements DatabaseStatementInterface {
    
    /**
     * Reference to the database connection object for this statement.
     *
     * The name $dbh is inherited from PDOStatement.
     *
     * @var DatabaseConnection
     */
    public $dbh;
    protected function __construct($dbh) {
        $this->dbh = $dbh;
        $this->setFetchMode(PDO::FETCH_OBJ);
    }
    public function execute($args = array(), $options = array()) {
        if (isset($options['fetch'])) {
            if (is_string($options['fetch'])) {
                // Default to an object. Note: db fields will be added to the object
                // before the constructor is run. If you need to assign fields after
                // the constructor is run, see http://drupal.org/node/315092.
                $this->setFetchMode(PDO::FETCH_CLASS, $options['fetch']);
            }
            else {
                $this->setFetchMode($options['fetch']);
            }
        }
        $logger = $this->dbh
            ->getLogger();
        if (!empty($logger)) {
            $query_start = microtime(TRUE);
        }
        $return = parent::execute($args);
        if (!empty($logger)) {
            $query_end = microtime(TRUE);
            $logger->log($this, $args, $query_end - $query_start);
        }
        return $return;
    }
    public function getQueryString() {
        return $this->queryString;
    }
    public function fetchCol($index = 0) {
        return $this->fetchAll(PDO::FETCH_COLUMN, $index);
    }
    public function fetchAllAssoc($key, $fetch = NULL) {
        $return = array();
        if (isset($fetch)) {
            if (is_string($fetch)) {
                $this->setFetchMode(PDO::FETCH_CLASS, $fetch);
            }
            else {
                $this->setFetchMode($fetch);
            }
        }
        foreach ($this as $record) {
            $record_key = is_object($record) ? $record->{$key} : $record[$key];
            $return[$record_key] = $record;
        }
        return $return;
    }
    public function fetchAllKeyed($key_index = 0, $value_index = 1) {
        $return = array();
        $this->setFetchMode(PDO::FETCH_NUM);
        foreach ($this as $record) {
            $return[$record[$key_index]] = $record[$value_index];
        }
        return $return;
    }
    public function fetchField($index = 0) {
        // Call PDOStatement::fetchColumn to fetch the field.
        return $this->fetchColumn($index);
    }
    public function fetchAssoc() {
        // Call PDOStatement::fetch to fetch the row.
        return $this->fetch(PDO::FETCH_ASSOC);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DatabaseStatementBase::$dbh public property Reference to the database connection object for this statement.
DatabaseStatementBase::execute public function Executes a prepared statement Overrides DatabaseStatementInterface::execute
DatabaseStatementBase::fetchAllAssoc public function Returns the result set as an associative array keyed by the given field. Overrides DatabaseStatementInterface::fetchAllAssoc
DatabaseStatementBase::fetchAllKeyed public function Returns the entire result set as a single associative array. Overrides DatabaseStatementInterface::fetchAllKeyed
DatabaseStatementBase::fetchAssoc public function Fetches the next row and returns it as an associative array. Overrides DatabaseStatementInterface::fetchAssoc
DatabaseStatementBase::fetchCol public function Returns an entire single column of a result set as an indexed array. Overrides DatabaseStatementInterface::fetchCol
DatabaseStatementBase::fetchField public function Returns a single field from the next record of a result set. Overrides DatabaseStatementInterface::fetchField
DatabaseStatementBase::getQueryString public function Gets the query string of this statement. Overrides DatabaseStatementInterface::getQueryString
DatabaseStatementBase::__construct protected function
DatabaseStatementInterface::rowCount public function Returns the number of rows affected by the last SQL statement. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.