API15

Difference between revisions of "JTable/bind"

From Joomla! Documentation

< API15:JTable
m (removing red link to edit, no existant pages)
Line 1: Line 1:
 
===Description===
 
===Description===
Binds a named array/hash to this object
+
Method to bind an associative array or object to the [http://api.joomla.org/1.5/Joomla-Framework/Table/JTable.html JTable] instance.  This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.  Binding is the process where values are copied into their equivalently named instance properties (see examples).
 
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
 
 
<! removed transcluded page call, red link never existed >
 
  
 
===Syntax===
 
===Syntax===

Revision as of 02:56, 3 July 2013

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

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. Binding is the process where values are copied into their equivalently named instance properties (see examples).

Syntax[edit]

bind($from, $ignore=array())
Parameter Name Default Value Description
$from mixed An associative array or object
$ignore array() mixed An array or space separated list of fields not to bind

Returns[edit]

boolean

Defined in[edit]

libraries/joomla/database/table.php

Importing[edit]

jimport( 'joomla.database.table' );

Source Body[edit]

function bind( $from, $ignore=array() )
{
        $fromArray      = is_array( $from );
        $fromObject     = is_object( $from );

        if (!$fromArray && !$fromObject)
        {
                $this->setError( get_class( $this ).'::bind failed. Invalid from argument' );
                return false;
        }
        if (!is_array( $ignore )) {
                $ignore = explode( ' ', $ignore );
        }
        foreach ($this->getProperties() as $k => $v)
        {
                // internal attributes of an object are ignored
                if (!in_array( $k, $ignore ))
                {
                        if ($fromArray && isset( $from[$k] )) {
                                $this->$k = $from[$k];
                        } else if ($fromObject && isset( $from->$k )) {
                                $this->$k = $from->$k;
                        }
                }
        }
        return true;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />