Source for file UpdateQuery.class.php

<?php
/**
 * @package harmoni.dbc
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: UpdateQuery.class.php,v 1.9 2007/09/05 21:38:59 adamfranco Exp $
 */
 
require_once(HARMONI."DBHandler/UpdateQuery.interface.php");
 
/**
 * An UpdateQuery class provides the tools to build an UPDATE query.
 *
 *
 * @package harmoni.dbc
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: UpdateQuery.class.php,v 1.9 2007/09/05 21:38:59 adamfranco Exp $
 */
 
class UpdateQuery 
    extends QueryAbstract
    implements UpdateQueryInterface
{
 
    /**
     * @var string $_table The name of the table to update.
     * @access private
     */
    var $_table;
 
    /**
     * @var array $_columns A list of the columns we will be updating.
     * @access private
     */
    var $_columns;
 
    /**
     * @var array $_values List of values that will be assigned to the columns.
     * @access private
     */
    var $_values;
 
 
    /**
     * This will store the condition in the WHERE clause. Each element of this
     * array stores 2 things: the condition itself, and the logical operator
     * to use to join with the previous condition.
     * @var array $_condition The condition in the WHERE clause.
     * @access private
     */
    var $_condition;
 
 
    /**
     * This is the constructor for a MySQL UPDATE query.
     * @access public
     */
    function UpdateQuery() {
        $this->reset();
    }
    
 
    /**
     * Sets the table to update.
     * @param string $table The table to insert into.
     * @access public
     */
    function setTable($table) {
        // ** parameter validation
        $stringRule = StringValidatorRule::getRule();
        ArgumentValidator::validate($table, $stringRule, true);
        // ** end of parameter validation
 
        $this->_table = $table;
    }
 
    /**
     * Sets the columns to update in the table.
     * @param array $table The columns to insert into the table.
     * @access public
     */
    function setColumns($columns) {
        // ** parameter validation
        $arrayRule = ArrayValidatorRule::getRule();
        ArgumentValidator::validate($columns, $arrayRule, true);
        // ** end of parameter validation
 
        $this->_columns = $columns;
    }
 
 
    /**
     * Specifies the values that the will be assigned to the columns specified with setColumns().
     *
     * @param array The values that the will be assigned to the columns specified with setColumns().
     * @access public
     */
    function setValues($values) {
        // ** parameter validation
        $arrayRule = ArrayValidatorRule::getRule();
        ArgumentValidator::validate($values, $arrayRule, true);
        // ** end of parameter validation
 
        $this->_values = $values;
    }
    
    /**
     * Add a column/value pair, if a value for the column exists, it will be
     * overwritten. The value will not have any new escaping or quotes added to it.
     * 
     * @param string $column 
     * @param string $value 
     * @return void 
     * @access public
     * @since 3/8/07
     */
    function addRawValue ( $column, $value ) {
        ArgumentValidator::validate($column, NonzeroLengthStringValidatorRule::getRule());
        ArgumentValidator::validate($value, NonzeroLengthStringValidatorRule::getRule());
        
        $key = array_search($column, $this->_columns);
        if ($key !== FALSE && is_int($key)) {
            $this->_values[$key] = $value;
        } else {
            $this->_columns[] = $column;
            $this->_values[] = $value;
        }
    }
    
    /**
     * Add a value, escaping it and surrounding it with quotes.
     * 
     * @param string $column 
     * @param string $value 
     * @return void 
     * @access public
     * @since 3/8/07
     */
    function addValue ( $column, $value ) {
        ArgumentValidator::validate($column, NonzeroLengthStringValidatorRule::getRule());
        ArgumentValidator::validate($value, StringValidatorRule::getRule());
        
        $this->addRawValue($column, "'".addslashes($value)."'");
    }
 
    /**
     * *Deprecated* Specifies the condition in the WHERE clause.
     *
     * The query will execute only on rows that fulfil the condition. If this method
     * is never called, then the WHERE clause will not be included.
     * @param string The WHERE clause condition.
     * @access public
     * @deprecated July 09, 2003 - Use addWhere() instead.
     */
    function setWhere($condition) {
        // ** parameter validation
        $stringRule = StringValidatorRule::getRule();
        ArgumentValidator::validate($condition, $stringRule, true);
        // ** end of parameter validation
 
        $arr = array();
        $arr[] = $condition;
        $arr[] = null;
        
        $this->_condition[] = $arr;
    }
 
 
 
    /**
     * Adds a new condition in the WHERE clause.
     * 
     * The query will execute only on rows that fulfil the condition. If this method
     * is never called, then the WHERE clause will not be included.
     * @param string condition The WHERE clause condition to add.
     * @param integer logicalOperation The logical operation to use to connect
     *  this WHERE condition with the previous WHERE conditions. Allowed values:
     *  <code>_AND</code> and <code>_OR</code>.
     * @access public
     * @return void 
     */
    function addWhere($condition, $logicalOperation = _AND) {
        // ** parameter validation
        $stringRule = StringValidatorRule::getRule();
        $integerRule = IntegerValidatorRule::getRule();
        $optionalRule = OptionalRule::getRule($integerRule);
        ArgumentValidator::validate($condition, $stringRule, true);
        ArgumentValidator::validate($logicalOperation, $optionalRule, true);
        // ** end of parameter validation
 
        $arr = array();
        $arr[] = $condition;
        $arr[] = $logicalOperation;
        
        $this->_condition[] = $arr;
    }
 
 
    /**
     * Resets the query.
     * @access public
     */
    function reset() {
        parent::reset();
 
        // an UPDATE query
        $this->_type = UPDATE;
        
        // default query configuration:
        
        // no table to update
        $this->_table = "";
 
        // no columns to update
        $this->_columns = array();
 
        // one row of values with no values specified
        $this->_values = array();
        
        // no WHERE condition, by default
        $this->_condition = array();
    }
 
}
?>