API16

JStream/deleteContextEntry: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JStream/deleteContextEntry}}
 


===Syntax===
===Syntax===
Line 55: Line 55:




{{subst:SeeAlso:JStream/deleteContextEntry}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=deleteContextEntry
  category=deleteContextEntry
  category=JStream
  category=JStream
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 02:07, 25 March 2017

Description

Deletes a particular setting from a context



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();
}



Examples

Code Examples