MDB2_Statement_Common Class Reference

Inheritance diagram for MDB2_Statement_Common:

Collaboration diagram for MDB2_Statement_Common:

Public Member Functions
	__construct (&$db, &$statement, $positions, $query, $types, $result_types, $is_manip=false, $limit=null, $offset=null)
	Constructor. More...
	MDB2_Statement_Common (&$db, &$statement, $positions, $query, $types, $result_types, $is_manip=false, $limit=null, $offset=null)
	PHP 4 Constructor. More...
	bindValue ($parameter, $value, $type=null)
	Set the value of a parameter of a prepared query. More...
	bindValueArray ($values, $types=null)
	Set the values of multiple a parameter of a prepared query in bulk. More...
	bindParam ($parameter, &$value, $type=null)
	Bind a variable to a parameter of a prepared query. More...
	bindParamArray (&$values, $types=null)
	Bind the variables of multiple a parameter of a prepared query in bulk. More...
&	execute ($values=null, $result_class=true, $result_wrap_class=false)
	Execute a prepared query statement. More...
&	_execute ($result_class=true, $result_wrap_class=false)
	Execute a prepared query statement helper method. More...
	free ()
	Release resources allocated for the specified prepared query. More...

Data Fields
	$db
	$statement
	$query
	$result_types
	$types
	$values = array()
	$limit
	$offset
	$is_manip

Detailed Description

Definition at line 3906 of file MDB2.php.

Constructor & Destructor Documentation

__construct()

MDB2_Statement_Common::__construct	(	&	$db,
		&	$statement,
			$positions,
			$query,
			$types,
			$result_types,
			$is_manip = false,
			$limit = null,
			$offset = null
	)

Constructor.

Definition at line 3926 of file MDB2.php.

References $query, and array.

    {
        $this->db =& $db;
        $this->statement =& $statement;
        $this->positions = $positions;
        $this->query = $query;
        $this->types = (array)$types;
        $this->result_types = (array)$result_types;
        $this->limit = $limit;
        $this->is_manip = $is_manip;
        $this->offset = $offset;
    }

Member Function Documentation

_execute()

& MDB2_Statement_Common::_execute	(		$result_class = true,
			$result_wrap_class = false
	)

Execute a prepared query statement helper method.

Parameters

mixed	specifies which result class to use
mixed	specifies which class to wrap results in

Returns

mixed MDB2_Result or integer on success, a MDB2 error on failure

private

Definition at line 4120 of file MDB2.php.

References $query, $result, $type, PEAR\isError(), and MDB2_ERROR_NOT_FOUND.

    {
        $this->last_query = $this->query;
        $query = '';
        $last_position = 0;
        foreach ($this->positions as $current_position => $parameter) {
            if (!array_key_exists($parameter, $this->values)) {
                return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
                    'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
            }
            $value = $this->values[$parameter];
            $query.= substr($this->query, $last_position, $current_position - $last_position);
            if (!isset($value)) {
                $value_quoted = 'NULL';
            } else {
                $type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null;
                $value_quoted = $this->db->quote($value, $type);
                if (PEAR::isError($value_quoted)) {
                    return $value_quoted;
                }
            }
            $query.= $value_quoted;
            $last_position = $current_position + 1;
        }
        $query.= substr($this->query, $last_position);

        $this->db->offset = $this->offset;
        $this->db->limit = $this->limit;
        if ($this->is_manip) {
            $result = $this->db->exec($query);
        } else {
            $result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class);
        }
        return $result;
    }

Here is the call graph for this function:

bindParam()

MDB2_Statement_Common::bindParam	(		$parameter,
		&	$value,
			$type = null
	)

Bind a variable to a parameter of a prepared query.

Parameters

int	the order number of the parameter in the query statement. The order number of the first parameter is 1.
mixed	variable that is meant to be bound to specified parameter. The type of the value depends on the $type argument.
string	specifies the type of the field

Returns

mixed MDB2_OK on success, a MDB2 error on failure

public

Definition at line 4027 of file MDB2.php.

References $type, MDB2_ERROR_NOT_FOUND, and MDB2_OK.

    {
        if (!is_numeric($parameter)) {
            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
        }
        if (!in_array($parameter, $this->positions)) {
            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
        }
        $this->values[$parameter] =& $value;
        if (!is_null($type)) {
            $this->types[$parameter] = $type;
        }
        return MDB2_OK;
    }

bindParamArray()

MDB2_Statement_Common::bindParamArray	(	&	$values,
			$types = null
	)

Bind the variables of multiple a parameter of a prepared query in bulk.

Parameters

array	specifies all necessary information for bindParam() the array elements must use keys corresponding to the number of the position of the parameter.
array	specifies the types of the fields

Returns

mixed MDB2_OK on success, a MDB2 error on failure

public

See also

bindParam()

Definition at line 4059 of file MDB2.php.

References $key, PEAR\isError(), and MDB2_OK.

    {
        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
        $parameters = array_keys($values);
        foreach ($parameters as $key => $parameter) {
            $err = $this->bindParam($parameter, $values[$parameter], $types[$key]);
            if (PEAR::isError($err)) {
                return $err;
            }
        }
        return MDB2_OK;
    }

Here is the call graph for this function:

bindValue()

MDB2_Statement_Common::bindValue	(		$parameter,
			$value,
			$type = null
	)

Set the value of a parameter of a prepared query.

Parameters

int	the order number of the parameter in the query statement. The order number of the first parameter is 1.
mixed	value that is meant to be assigned to specified parameter. The type of the value depends on the $type argument.
string	specifies the type of the field

Returns

mixed MDB2_OK on success, a MDB2 error on failure

public

Definition at line 3966 of file MDB2.php.

References $type, MDB2_ERROR_NOT_FOUND, and MDB2_OK.

    {
        if (!is_numeric($parameter)) {
            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
        }
        if (!in_array($parameter, $this->positions)) {
            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
        }
        $this->values[$parameter] = $value;
        if (!is_null($type)) {
            $this->types[$parameter] = $type;
        }
        return MDB2_OK;
    }

bindValueArray()

MDB2_Statement_Common::bindValueArray	(		$values,
			$types = null
	)

Set the values of multiple a parameter of a prepared query in bulk.

Parameters

array	specifies all necessary information for bindValue() the array elements must use keys corresponding to the number of the position of the parameter.
array	specifies the types of the fields

Returns

mixed MDB2_OK on success, a MDB2 error on failure

public

See also

bindParam()

Definition at line 3998 of file MDB2.php.

References $key, PEAR\isError(), and MDB2_OK.

    {
        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
        $parameters = array_keys($values);
        foreach ($parameters as $key => $parameter) {
            $err = $this->bindValue($parameter, $values[$parameter], $types[$key]);
            if (PEAR::isError($err)) {
                return $err;
            }
        }
        return MDB2_OK;
    }

Here is the call graph for this function:

execute()

& MDB2_Statement_Common::execute	(		$values = null,
			$result_class = true,
			$result_wrap_class = false
	)

Execute a prepared query statement.

Parameters

array	specifies all necessary information for bindParam() the array elements must use keys corresponding to the number of the position of the parameter.
mixed	specifies which result class to use
mixed	specifies which class to wrap results in

Returns

mixed a result handle or MDB2_OK on success, a MDB2 error on failure

public

Definition at line 4088 of file MDB2.php.

References $result, array, PEAR\isError(), and MDB2_ERROR.

    {
        if (is_null($this->positions)) {
            return $this->db->raiseError(MDB2_ERROR, null, null,
                'Prepared statement has already been freed', __FUNCTION__);
        }

        $values = (array)$values;
        if (!empty($values)) {
            $err = $this->bindValueArray($values);
            if (PEAR::isError($err)) {
                return $this->db->raiseError(MDB2_ERROR, null, null,
                                            'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__);
            }
        }
        $result =& $this->_execute($result_class, $result_wrap_class);
        return $result;
    }

Here is the call graph for this function:

free()

MDB2_Statement_Common::free

(

)

Release resources allocated for the specified prepared query.

Returns

mixed MDB2_OK on success, a MDB2 error on failure

public

Definition at line 4166 of file MDB2.php.

References MDB2_ERROR, and MDB2_OK.

    {
        if (is_null($this->positions)) {
            return $this->db->raiseError(MDB2_ERROR, null, null,
                'Prepared statement has already been freed', __FUNCTION__);
        }

        $this->statement = null;
        $this->positions = null;
        $this->query = null;
        $this->types = null;
        $this->result_types = null;
        $this->limit = null;
        $this->is_manip = null;
        $this->offset = null;
        $this->values = null;

        return MDB2_OK;
    }

MDB2_Statement_Common()

MDB2_Statement_Common::MDB2_Statement_Common	(	&	$db,
		&	$statement,
			$positions,
			$query,
			$types,
			$result_types,
			$is_manip = false,
			$limit = null,
			$offset = null
	)

PHP 4 Constructor.

Definition at line 3945 of file MDB2.php.

    {
        $this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
    }

Field Documentation

$db

MDB2_Statement_Common::$db

Definition at line 3910 of file MDB2.php.

$is_manip

MDB2_Statement_Common::$is_manip

Definition at line 3918 of file MDB2.php.

$limit

MDB2_Statement_Common::$limit

Definition at line 3916 of file MDB2.php.

$offset

MDB2_Statement_Common::$offset

Definition at line 3917 of file MDB2.php.

$query

MDB2_Statement_Common::$query

Definition at line 3912 of file MDB2.php.

$result_types

MDB2_Statement_Common::$result_types

Definition at line 3913 of file MDB2.php.

$statement

MDB2_Statement_Common::$statement

Definition at line 3911 of file MDB2.php.

$types

MDB2_Statement_Common::$types

Definition at line 3914 of file MDB2.php.

$values

MDB2_Statement_Common::$values = array()

Definition at line 3915 of file MDB2.php.

---

The documentation for this class was generated from the following file:

• Services/Database/lib/PEAR/MDB2.php