API17

Difference between revisions of "JSessionStorage::gc"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JSessionStorage::gc|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JSessionStorage::gc|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JSessionStorage::gc ($maxlifetime=null)
+
public function gc ($maxlifetime=null)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 25: Line 24:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True on success, false otherwise.
boolean True on success, false otherwise.
+
* '''Defined''' on line 141 of libraries/joomla/session/storage.php
===Defined in===
 
libraries/joomla/session/storage.php (line 156)
 
* see source code in [[jplatform:session/storage.php#cl-156|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JSessionStorage::gc source code''' on [[jplatform:session/storage.php#cl-133|BitBucket]]
 +
* {{JVer|11.1}} Class [[JSessionStorage/11.1|JSessionStorage]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Session/11.1|Session]]
 +
* [[JSessionStorage::gc|Other versions of JSessionStorage::gc]]
 +
{{SeeAlso:JSessionStorage::gc}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JSessionStorage::gc|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JSessionStorage::gc|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JSessionStorage/11.1|JSessionStorage]]
+
===User contributed notes===
* [[JSessionStorage::gc|Other versions of this method]]
 
{{SeeAlso:JSessionStorage::gc}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 46: Line 43:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JSessionStorage]][[Category:JSessionStorage::gc]]</noinclude>
 
<noinclude>[[Category:JSessionStorage]][[Category:JSessionStorage::gc]]</noinclude>

Revision as of 21:37, 27 April 2011

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JSessionStorage::gc[edit]

Description[edit]

Garbage collect stale sessions from the SessionHandler backend.

Template:Description:JSessionStorage::gc [Edit Descripton]

public function gc ($maxlifetime=null)
Parameter Type Default Description
$maxlifetime integer null The maximum age of a session.
  • Returns boolean True on success, false otherwise.
  • Defined on line 141 of libraries/joomla/session/storage.php

See also[edit]

Template:SeeAlso:JSessionStorage::gc [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />