API16

JAdapter/setAdapter: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Set an adapter by name <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </s...
 
Doxiki (talk | contribs)
No edit summary
Line 21: Line 21:
|  $name Adapter name  
|  $name Adapter name  
|-
|-
|  
| &$adapter
| null
| null
|  $adapter Adapter object  
|  $adapter Adapter object  

Revision as of 10:00, 30 March 2010

Description

Set an adapter by name

[Edit Descripton]

Template:Description:JAdapter/setAdapter

Syntax

setAdapter($name, &$adapter=null)
Parameter Name Default Value Description
$name $name Adapter name
&$adapter null $adapter Adapter object

Returns

boolean True if successful

Defined in

libraries/joomla/base/adapter.php

Importing

jimport( 'joomla.base.adapter' );

Source Body

public function setAdapter($name, &$adapter = null)
{
        if (!is_object($adapter))
        {
                // Try to load the adapter object
                require_once $this->_basepath.DS.$this->_adapterfolder.DS.strtolower($name).'.php';
                $class = $this->_classprefix.ucfirst($name);
                if (!class_exists($class)) {
                        return false;
                }
                $adapter = new $class($this, $this->_db);
        }
        $this->_adapters[$name] =& $adapter;
        return true;
}

[Edit See Also] Template:SeeAlso:JAdapter/setAdapter

Examples

<CodeExamplesForm />