API16:JTable/bind

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Method to bind an associative array or object to the JTable instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.

Syntax

bind($src, $ignore=array())

Parameter Name	Default Value	Description
$src		An associative array or object to bind to the instance.
$ignore	array()	An optional array or space separated list of properties to ignore while binding.

Returns

boolean True on success.

Defined in

libraries/joomla/database/table.php

Importing

jimport( 'joomla.database.table' );

Source Body

public function bind($src, $ignore = array())
{
        // If the source value is not an array or object return false.
        if (!is_object($src) && !is_array($src)) {
                $this->setError(get_class($this).'::bind failed. Invalid source argument');
                return false;
        }
 
        // If the source value is an object, get its accessible properties.
        if (is_object($src)) {
                $src = get_object_vars($src);
        }
 
        // If the ignore value is a string, explode it over spaces.
        if (!is_array($ignore)) {
                $ignore = explode(' ', $ignore);
        }
 
        // Bind the source value, excluding the ignored fields.
        foreach ($this->getProperties() as $k => $v) {
                // Only process fields not in the ignore array.
                if (!in_array($k, $ignore)) {
                        if (isset($src[$k])) {
                                $this->$k = $src[$k];
                        }
                }
        }
 
        return true;
}

Examples

<CodeExamplesForm />