Actions

API15

Difference between revisions of "JTable::bind Example001"

From Joomla! Documentation

(See also: Delete page that doesn't exist)
(Remove text moved to The API15 pages and leave this as an example page)
Line 1: Line 1:
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).
 
 
===Syntax===
 
''boolean'' bind( $from, [$ignore = array()] ) 
 
 
=== Parameters ===
 
{| class="wikitable"
 
!Argument
 
!Data type
 
!Description
 
!Default
 
|-
 
|$from
 
|array or object
 
|An associative array or object to be bind to the [[JTable]] instance.
 
|
 
|-
 
|$ignore
 
|array or string
 
|An optional array or space separated list of properties to ignore while binding.
 
|array()
 
|}
 
 
Returns '''true''' if bind was successful.
 
 
 
===Example===
 
===Example===
 
In this example the class '''TableGreeting''' corresponds to a table called 'jos_greeting' in the Joomla database.
 
In this example the class '''TableGreeting''' corresponds to a table called 'jos_greeting' in the Joomla database.
Line 79: Line 54:
 
* the '_code' array entry has not been bound to the table because it is a private property of the table object (its name begins with an underscore).
 
* the '_code' array entry has not been bound to the table because it is a private property of the table object (its name begins with an underscore).
  
===See also===
+
<noinclude>[[Category:CodeExample]][[Category:MethodExample]][[Category:JTable]]</noinclude>
* [http://api.joomla.org/Joomla-Framework/Table/JTable.html#bind JTable->addIncludePath on api.joomla.org]
+
* [[JTable/load|JTable->load]]
+
* [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface#Creating the Table Class | Creating a JTable Child Class (MVC Tutorial Part 4)]]
+
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JTable]]</noinclude>
+

Revision as of 02:59, 3 July 2013

Replacement filing cabinet.png
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.

Example

In this example the class TableGreeting corresponds to a table called 'jos_greeting' in the Joomla database.

class TableGreeting extends JTable
{
   var $id       = null;
   var $greeting = null;
   var $language = null;
   var $_code    = null;
 
   function __construct( &$db )
   {
        parent::__construct( '#__greeting', 'id', $db );
   }
}

Now, in the model, create an array of fields/properties to be updated and bind it to the table object:

// Create the array of new/amended fields/properties.
$from = array( 'id'        => 6,
               'greeting'  => 'Nǐ hǎo',
               'language'  => 'Chinese',
               'continent' => 'Asia'
               '_code'     => 'ASC012'
             );
// Specify which columns are to be ignored. This can be a string or an array.
$ignore = 'id';
 
// Get the table object from the model.
$table = $this->getTable( 'greeting' );
 
// Bind the array to the table object.
$table->bind( $from, $ignore );
 
// Show the result of the bind for illustration purposes only.
echo '<pre>';
print_r( $table );
echo '</pre>';

This would result in the following output:

TableGreeting Object
(
    [id] => 
    [greeting] => Nǐ hǎo
    [language] => Chinese
    [_code] =>
)

Notice that

  • the 'continent' array entry has not been bound to the table object, since 'continent' is not a property of the object.
  • the 'id' array entry has not been bound to the table object either, since 'id' was on the ignore list.
  • the '_code' array entry has not been bound to the table because it is a private property of the table object (its name begins with an underscore).