Actions

API16

JCacheOutput/start

From Joomla! Documentation

< API16:JCacheOutput
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.

Contents

Description

Start the cache

[<! removed edit link to red link >]

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

Syntax

start($id, $group=null)
Parameter Name Default Value Description
$id $id The cache data id
$group null $group The cache data group

Returns

boolean True if the cache is hit (false else)

Defined in

libraries/joomla/cache/handler/output.php

Importing

jimport( 'joomla.cache.handler.output' );

Source Body

function start($id, $group=null)
{
        // If we have data in cache use that...
        $data = $this->get($id, $group);
        if ($data !== false) {
                echo $data;
                return true;
        } else {
                // Nothing in cache... lets start the output buffer and start collecting data for next time.
                ob_start();
                ob_implicit_flush(false);
                // Set id and group placeholders
                $this->_id              = $id;
                $this->_group   = $group;
                return false;
        }
}

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

Examples

<CodeExamplesForm />