API15

API15:JCache/getInstance

From Joomla! Documentation

Revision as of 00:21, 25 March 2017 by JoomlaWikiBot (talk | contribs) (preparing for archive only)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Returns a reference to a cache adapter object, always creating it

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

& getInstance($type= 'output', $options=array())
Parameter Name Default Value Description
$type 'output' $type The cache object type to instantiate
$options array()

Returns

object A object

Defined in

libraries/joomla/cache/cache.php

Importing

jimport( 'joomla.cache.cache' );

Source Body

function &getInstance($type = 'output', $options = array())
{
        $type = strtolower(preg_replace('/[^A-Z0-9_\.-]/i', '', $type));

        $class = 'JCache'.ucfirst($type);

        if(!class_exists($class))
        {
                $path = dirname(__FILE__).DS.'handler'.DS.$type.'.php';

                if (file_exists($path)) {
                        require_once($path);
                } else {
                        JError::raiseError(500, 'Unable to load Cache Handler: '.$type);
                }
        }

        $instance = new $class($options);

        return $instance;
}

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

Examples

Code Examples