rhymix/modules/member/php-openid-1.2.3/doc/Yadis/Services_Yadis_PHPSession.html
2008-12-19 11:00:19 +00:00

203 lines
No EOL
7.1 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Services_Yadis_PHPSession</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Services_Yadis_PHPSession</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The base session class used by the Services_Yadis_Manager. This class wraps the default PHP session machinery and should be subclassed if your application doesn't use PHP sessioning.</p>
<p class="notes">
Located in <a class="field" href="_Services---Yadis---Manager.php.html">/Services/Yadis/Manager.php</a> (line <span class="field">17</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">void</span>
<a href="#contents" title="details" class="method-name">contents</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#del" title="details" class="method-name">del</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#get" title="details" class="method-name">get</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#set" title="details" class="method-name">set</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodcontents" id="contents"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">contents</span> (line <span class="line-number">60</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the contents of the session in array form.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
contents
</span>
()
</div>
</div>
<a name="methoddel" id="del"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">del</span> (line <span class="line-number">52</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a key/value pair from the session.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
del
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the key to remove.</span> </li>
</ul>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">get</span> (line <span class="line-number">38</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a key's value from the session.</p>
<ul class="tags">
<li><span class="field">return:</span> The key's value in the session or $default if it isn't found.</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
get
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the key to retrieve.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$default</span><span class="var-description">: The optional value to return if the key is not found in the session.</span> </li>
</ul>
</div>
<a name="methodset" id="set"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">set</span> (line <span class="line-number">24</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a session key/value pair.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
set
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the session key to add.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: The value to add to the session.</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 10 Sep 2007 13:29:29 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>