Location: PHPKode > projects > PHP on Trax > johnpipi-trax-f599562/trax/doc/PHPonTrax/Session.html
<html>
<head>
<title>Docs For Class Session</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">PHPonTrax</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_PHPonTrax.html" class="menu">class tree: PHPonTrax</a> ]
		  [ <a href="../elementindex_PHPonTrax.html" class="menu">index: PHPonTrax</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
	<div id="todolist">
			<p><a href="../todolist.html">Todo List</a></p>
	</div>
      <b>Packages:</b><br />
              <a href="../li_PHPonTrax.html">PHPonTrax</a><br />
              <a href="../li_PHPonTraxTest.html">PHPonTraxTest</a><br />
            <br /><br />
		<b>Tutorials/Manuals:</b><br />
					<strong>Package-level:</strong>
							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_PHPonTrax.pkg.html">PHP On Trax</a>
<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_rails_examples.pkg.html">Examples From The Rails Book</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_simpleapp.pkg.html">Build A Simple Trax Application</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_database.pkg.html">Create A Database and User</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_advbuild.pkg.html">Advanced Application Build Topics</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_naming.pkg.html">The Trax Naming Convention</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_troubleshoot.pkg.html">Troubleshooting</a>
</ul>

<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_reference.pkg.html">Reference</a>
</ul>

</li></ul>


										<strong>Class-level:</strong>
							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecordHelper.cls.html">ActiveRecordHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_FormTagHelper.cls.html">FormTagHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_Helpers.cls.html">Helpers</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_UrlHelper.cls.html">UrlHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_FormHelper.cls.html">FormHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_InputFilter.cls.html">InputFilter</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActionMailer.cls.html">ActionMailer</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ApplicationController.cls.html">ApplicationController</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActionController.cls.html">ActionController</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecord.cls.html">ActiveRecord</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_DateHelper.cls.html">DateHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_Router.cls.html">Router</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_FormOptionsHelper.cls.html">FormOptionsHelper</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_TraxGenerator.cls.html">TraxGenerator</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_Session.cls.html">Session</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_Inflector.cls.html">Inflector</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecordError.cls.html">ActiveRecordError</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ActionControllerError.cls.html">ActionControllerError</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ScaffoldController.cls.html">ScaffoldController</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_Dispatcher.cls.html">Dispatcher</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_TraxError.cls.html">TraxError</a>
</ul>


							<ul>
	<li type="square"><a href="../PHPonTrax/tutorial_ApplicationMailer.cls.html">ApplicationMailer</a>
</ul>


							                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../PHPonTrax/_vendor_trax_action_controller_php.html">		action_controller.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_mailer_php.html">		action_mailer.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_php.html">		action_view.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_active_record_php.html">		active_record.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_active_record_helper_php.html">		active_record_helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_add_phtml.html">		add.phtml
		</a><br>
			<a href="../PHPonTrax/_data_app_controllers_application_php.html">		application.php
		</a><br>
			<a href="../PHPonTrax/_data_app_views_layouts_application_phtml.html">		application.phtml
		</a><br>
			<a href="../PHPonTrax/_data_app_helpers_application_helper_php.html">		application_helper.php
		</a><br>
			<a href="../PHPonTrax/_data_app_application_mailer_php.html">		application_mailer.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_asset_tag_helper_php.html">		asset_tag_helper.php
		</a><br>
			<a href="../PHPonTrax/_test_layouts_catalog_phtml.html">		catalog.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_controller_php.html">		controller.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_controller_php.html">		controller.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_date_helper_php.html">		date_helper.php
		</a><br>
			<a href="../PHPonTrax/_data_config_environments_development_php.html">		development.php
		</a><br>
			<a href="../PHPonTrax/_data_public_dispatch_php.html">		dispatch.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_dispatcher_php.html">		dispatcher.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_edit_phtml.html">		edit.phtml
		</a><br>
			<a href="../PHPonTrax/_data_config_environment_php.html">		environment.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_error_phtml.html">		error.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_helper_php.html">		form_helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_options_helper_php.html">		form_options_helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_form_scaffolding_phtml.html">		form_scaffolding.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_tag_helper_php.html">		form_tag_helper.php
		</a><br>
			<a href="../PHPonTrax/_data_script_generate_php.html">		generate.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_helper_php.html">		helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_php.html">		helpers.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_index_phtml.html">		index.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_inflector_php.html">		inflector.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_input_filter_php.html">		input_filter.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_javascript_helper_php.html">		javascript_helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_layout_phtml.html">		layout.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_layout_phtml.html">		layout.phtml
		</a><br>
			<a href="../PHPonTrax/_makepkg_php.html">		makepkg.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_model_php.html">		model.php
		</a><br>
			<a href="../PHPonTrax/_data_config_environments_production_php.html">		production.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_router_php.html">		router.php
		</a><br>
			<a href="../PHPonTrax/_data_config_routes_php.html">		routes.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_scaffold_controller_php.html">		scaffold_controller.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_session_php.html">		session.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_show_phtml.html">		show.phtml
		</a><br>
			<a href="../PHPonTrax/_data_config_environments_test_php.html">		test.php
		</a><br>
			<a href="../PHPonTrax/_trax_php.html">		trax.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_trax_exceptions_php.html">		trax_exceptions.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_trax_generator_php.html">		trax_generator.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_action_view_helpers_url_helper_php.html">		url_helper.php
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_view_phtml.html">		view.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_add_phtml.html">		view_add.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_edit_phtml.html">		view_edit.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_index_phtml.html">		view_index.phtml
		</a><br>
			<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_show_phtml.html">		view_show.phtml
		</a><br>
	  </div><br />

      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../PHPonTrax/.html"></a><br />
	    		<a href="../PHPonTrax/ActionController.html">ActionController</a><br />
	    		<a href="../PHPonTrax/ActionControllerError.html">ActionControllerError</a><br />
	    		<a href="../PHPonTrax/ActionMailer.html">ActionMailer</a><br />
	    		<a href="../PHPonTrax/ActiveRecord.html">ActiveRecord</a><br />
	    		<a href="../PHPonTrax/ActiveRecordError.html">ActiveRecordError</a><br />
	    		<a href="../PHPonTrax/ActiveRecordHelper.html">ActiveRecordHelper</a><br />
	    		<a href="../PHPonTrax/ApplicationController.html">ApplicationController</a><br />
	    		<a href="../PHPonTrax/ApplicationMailer.html">ApplicationMailer</a><br />
	    		<a href="../PHPonTrax/AssetTagHelper.html">AssetTagHelper</a><br />
	    		<a href="../PHPonTrax/DateHelper.html">DateHelper</a><br />
	    		<a href="../PHPonTrax/Dispatcher.html">Dispatcher</a><br />
	    		<a href="../PHPonTrax/FormHelper.html">FormHelper</a><br />
	    		<a href="../PHPonTrax/FormOptionsHelper.html">FormOptionsHelper</a><br />
	    		<a href="../PHPonTrax/FormTagHelper.html">FormTagHelper</a><br />
	    		<a href="../PHPonTrax/Helpers.html">Helpers</a><br />
	    		<a href="../PHPonTrax/Inflector.html">Inflector</a><br />
	    		<a href="../PHPonTrax/InputFilter.html">InputFilter</a><br />
	    		<a href="../PHPonTrax/JavaScriptHelper.html">JavaScriptHelper</a><br />
	    		<a href="../PHPonTrax/Router.html">Router</a><br />
	    		<a href="../PHPonTrax/ScaffoldController.html">ScaffoldController</a><br />
	    		<a href="../PHPonTrax/Session.html">Session</a><br />
	    		<a href="../PHPonTrax/TraxError.html">TraxError</a><br />
	    		<a href="../PHPonTrax/TraxGenerator.html">TraxGenerator</a><br />
	    		<a href="../PHPonTrax/UrlHelper.html">UrlHelper</a><br />
	  </div>

                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Session</h1>
Source Location: /vendor/trax/session.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Keep track of state of the client's session with the server</div><br /><br />
<h4>Author(s):</h4>
<ul>
        </ul>




    


</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../PHPonTrax/Session.html#var$id">$id</a></li>
    <li><a href="../PHPonTrax/Session.html#var$ip">$ip</a></li>
    <li><a href="../PHPonTrax/Session.html#var$user_agent">$user_agent</a></li>
  </ul>
</td>

<td valign="top">
<h3><a href="#class_consts">Constants</a></h3>
<ul>
    <li><a href="../PHPonTrax/Session.html#constTRAX_SESSION_LIFETIME">TRAX_SESSION_LIFETIME</a></li>
    <li><a href="../PHPonTrax/Session.html#constTRAX_SESSION_MAXLIFETIME_MINUTES">TRAX_SESSION_MAXLIFETIME_MINUTES</a></li>
    <li><a href="../PHPonTrax/Session.html#constTRAX_SESSION_NAME">TRAX_SESSION_NAME</a></li>
  </ul>
</td>

<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../PHPonTrax/Session.html#methoddestory_session">destory_session</a></li>
    <li><a href="../PHPonTrax/Session.html#methodflash">flash</a></li>
    <li><a href="../PHPonTrax/Session.html#methodget">get</a></li>
    <li><a href="../PHPonTrax/Session.html#methodget_hash">get_hash</a></li>
    <li><a href="../PHPonTrax/Session.html#methodisset_flash">isset_flash</a></li>
    <li><a href="../PHPonTrax/Session.html#methodisset_var">isset_var</a></li>
    <li><a href="../PHPonTrax/Session.html#methodis_aol_host">is_aol_host</a></li>
    <li><a href="../PHPonTrax/Session.html#methodis_valid_host">is_valid_host</a></li>
    <li><a href="../PHPonTrax/Session.html#methodset">set</a></li>
    <li><a href="../PHPonTrax/Session.html#methodstart">start</a></li>
    <li><a href="../PHPonTrax/Session.html#methodunset_session">unset_session</a></li>
    <li><a href="../PHPonTrax/Session.html#methodunset_var">unset_var</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a44">44</a>]<br />
Keep track of state of the client's session with the server<br /><br /><p>Since there is no continuous connection between the client and the   web server, there must be some way to carry information forward   from one page to the next.  PHP does this with a global array variable   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a>   which is automatically restored from an area of the server's hard disk   indicated by the contents of a cookie stored on the client's computer.   This class is a static class with convenience methods for accessing the   contents of $_SESSION.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/tutorial_Session.cls.html">Session</a></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$id"></a>
	<p></p>
	<h4>$id = <span class="value">&nbsp;null</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a78">78</a>]</p>
  Session ID<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$ip"></a>
	<p></p>
	<h4>$ip = <span class="value">&nbsp;null</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a66">66</a>]</p>
  IP Address of client<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodstart">Session::start()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>private</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$user_agent"></a>
	<p></p>
	<h4>$user_agent = <span class="value">&nbsp;null</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a72">72</a>]</p>
  User Agent (OS, Browser, etc) of client<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodstart">Session::start()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>private</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methoddestory_session"></a>
	<h3>method destory_session <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a221">221</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void destory_session(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Destroy the user's session<br /><br /><p>Destroy all data registered to a session</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/session_destroy">session_destroy()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodflash"></a>
	<h3>method flash <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a327">327</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed flash(
mixed
$key, [string
$value = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get or set a flash message<br /><br /><p>A flash message is a message that will appear prominently on   the next screen to be sent to the user. Flash   messages are intended to be shown to the user once then erased.   They are stored in the   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a>   array for the user's session.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>Content of the flash message with the specified                 key if $value is null; otherwise null.</td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$key</b>&nbsp;&nbsp;</td>
        <td>Key to identify one particular flash message                     of potentially many for this session</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>Content of the flash message if present</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget"></a>
	<h3>method get <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a92">92</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed get(
mixed
$key)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get a session variable<br /><br /><p>Fetch the contents from a specified element of   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>Content of the session variable with the specified                 key if the variable exists; otherwise null.</td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$key</b>&nbsp;&nbsp;</td>
        <td>Key to identify one particular session variable                     of potentially many for this session</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget_hash"></a>
	<h3>method get_hash <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a169">169</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void get_hash(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get key that uniquely identifies this session<br /><br /><p>Calculate a unique session key based on the session ID and   user agent, plus the user's IP address if not on AOL.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodunset_var">Session::unset_var()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodisset_var">Session::isset_var()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodisset_flash">Session::isset_flash()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodflash">Session::flash()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodunset_session">Session::unset_session()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodset">Session::set()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/md5">md5()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/session_id">session_id()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget">Session::get()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_aol_host">Session::is_aol_host()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisset_flash"></a>
	<h3>method isset_flash <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a297">297</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean isset_flash(
mixed
$key)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Test whether there is a flash message to be shown<br /><br /><p>Check whether the   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a>   array for this session contains a   flash message to be shown to the user.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td><ul><li>true =&gt;  A flash message is present</li><li>false =&gt; No flash message is present</li></ul></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$key</b>&nbsp;&nbsp;</td>
        <td>Key to identify one particular flash message                     of potentially many for this session</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisset_var"></a>
	<h3>method isset_var <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a271">271</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean isset_var(
mixed
$key)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Test whether a session variable is defined in $_SESSION<br /><br /><p>Check the   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a>   array for the existance of a variable identified by $key</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td><ul><li>true =&gt;  The specified session variable is
                         defined.</li><li>false =&gt; The specified session variable is
                         not defined.</li></ul></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$key</b>&nbsp;&nbsp;</td>
        <td>Key to identify one particular session variable                     of potentially many for this session</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodis_aol_host"></a>
	<h3>method is_aol_host <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a152">152</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean is_aol_host(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Test whether the client is an AOL user<br /><br /><p>Check whether the domain name of the client's IP ends in   &quot;proxy.aol.com&quot; or the client's user agent name includes &quot;AOL&quot;</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td><ul><li>true =&gt;  Client is on AOL</li><li>false =&gt; Client from some other ISP</li></ul></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodis_valid_host"></a>
	<h3>method is_valid_host <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a133">133</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean is_valid_host(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Test whether the user host is as expected for this session<br /><br /><p>Compare the REMOTE_ADDR and HTTP_USER_AGENT elements of   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.server">$_SERVER</a>   to the expected values for this session.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td><ul><li>true =&gt;  User host is as expected</li><li>false =&gt; User host NOT as expected</li></ul></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodunset_var">Session::unset_var()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodisset_var">Session::isset_var()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodisset_flash">Session::isset_flash()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodflash">Session::flash()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodstart">Session::start()</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodset">Session::set()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_aol_host">Session::is_aol_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#var$user_agent">Session::$user_agent</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget">Session::get()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#var$ip">Session::$ip</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodset"></a>
	<h3>method set <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a112">112</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void set(
mixed
$key, string
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set a session variable<br /><br /><p>Store a value in a specified element of   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$key</b>&nbsp;&nbsp;</td>
        <td>Key to identify one particular session variable                     of potentially many for this session</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>Value to store in the session variable                        identified by $key</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodstart"></a>
	<h3>method start <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a188">188</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void start(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Start or continue a session<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#var$user_agent">Session::$user_agent</a></td>
  </tr>
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Dispatcher.html#methoddispatch">Dispatcher::dispatch()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/session_start">session_start()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/session_id">session_id()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#var$ip">Session::$ip</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/ini_set">ini_set()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodunset_session"></a>
	<h3>method unset_session <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a231">231</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void unset_session(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Free all session variables currently registered<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="http://www.php.net/session_unset">session_unset()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodunset_var"></a>
	<h3>method unset_var <span class="smalllinenumber">[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a244">244</a>]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void unset_var(
mixed
$key)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Unset a session variable<br /><br /><p>Unset the variable in   <a href="http://www.php.net/manual/en/reserved.variables.php#reserved.variables.session">$_SESSION</a>   identified by key $key</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/ActionController.html#methodprocess_route">ActionController::process_route()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodis_valid_host">Session::is_valid_host()</a></td>
  </tr>
  <tr>
    <td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../PHPonTrax/Session.html#methodget_hash">Session::get_hash()</a></td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />

<hr />
<a name="class_constss"></a>
<h3>Class Constants</h3>
<div class="tags">
	<a name="constTRAX_SESSION_LIFETIME"></a>
	<p></p>
	<h4>TRAX_SESSION_LIFETIME = <span class="value">&nbsp;&quot;0&quot;</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a54">54</a>]</p>
  Lifetime in seconds of cookie or, if 0, until browser is restarted.<br /><br />
  <br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="constTRAX_SESSION_MAXLIFETIME_MINUTES"></a>
	<p></p>
	<h4>TRAX_SESSION_MAXLIFETIME_MINUTES = <span class="value">&nbsp;&quot;20&quot;</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a60">60</a>]</p>
  After this number of minutes, stored data will be seen as   'garbage' and cleaned up by the garbage collection process.<br /><br />
  <br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="constTRAX_SESSION_NAME"></a>
	<p></p>
	<h4>TRAX_SESSION_NAME = <span class="value">&nbsp;&quot;TRAXSESSID&quot;</span></h4>
	<p>[line <a href="..//__filesource/fsource_PHPonTrax__vendortraxsession.php.html#a49">49</a>]</p>
  Name of the session (used as cookie name).<br /><br />
  <br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

        <div class="credit">
		    <hr />
		    Documentation generated on Thu, 04 May 2006 19:47:54 -0600 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC4</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>
Return current item: PHP on Trax