API15

JSessionStorageXcache/destroy: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 50: Line 50:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=destroy
  category=destroy
  category=JSessionStorageXcache
  category=JSessionStorageXcache
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:08, 25 March 2017

Description

Destroy the data for a particular session identifier in the SessionHandler backend.

[<! removed edit link to red link >]

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

Syntax

destroy($id)
Parameter Name Default Value Description
$id $id The session identifier.

Returns

boolean True on success, false otherwise.

Defined in

libraries/joomla/session/storage/xcache.php

Importing

jimport( 'joomla.session.storage.xcache' );

Source Body

function destroy($id)
{
        $sess_id = 'sess_'.$id;

        if( !xcache_isset( $sess_id ) ){
                return true;
        }

        return xcache_unset($sess_id);
}

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

Examples

Code Examples