API16

JSessionStorageXcache/gc: Difference between revisions

From Joomla! Documentation

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




{{subst:Description:JSessionStorageXcache/gc}}
 


===Syntax===
===Syntax===
Line 37: Line 37:




{{subst:SeeAlso:JSessionStorageXcache/gc}}
 


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

Latest revision as of 02:05, 25 March 2017

Description

Garbage collect stale sessions from the SessionHandler backend.



Syntax

gc($maxlifetime)
Parameter Name Default Value Description
$maxlifetime $maxlifetime The maximum age of a session.

Returns

boolean True on success, false otherwise.

Defined in

libraries/joomla/session/storage/xcache.php

Importing

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

Source Body

function gc($maxlifetime)
{
        return true;
}



Examples

Code Examples