Actions

API16

JStream/deleteContextEntry

From Joomla! Documentation

< API16:JStream
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

Deletes a particular setting from a context

[Edit Descripton]

Description:JStream/deleteContextEntry

Syntax

deleteContextEntry($wrapper, $name)
Parameter Name Default Value Description
$wrapper The wrapper to use
$name The option to unset

Defined in

libraries/joomla/filesystem/stream.php

Importing

jimport( 'joomla.filesystem.stream' );

Source Body

function deleteContextEntry($wrapper, $name)
{
        // check the wrapper is set
        if(isset($this->_contextOptions[$wrapper]))
        {
                // check that entry is set for that wrapper
                if(isset($this->_contextOptions[$wrapper][$name]))
                {
                        // unset the item
                        unset($this->_contextOptions[$wrapper][$name]);
 
                        // check that there are still items there
                        if(!count($this->_contextOptions[$wrapper])) {
                                // clean up an empty wrapper context option
                                unset($this->_contextOptions[$wrapper]);
                        }
                }
        }
        // rebuild the context and apply it to the stream
        $this->_buildContext();
}

[Edit See Also] SeeAlso:JStream/deleteContextEntry

Examples

<CodeExamplesForm />