Class Session

Package: minPHP
Located at components/session/session.php

Methods summary

`public`	# `__construct( )` Initialize the Session Initialize the Session
`public`	# `__destruct( )` Clean up any loose ends Clean up any loose ends
`public string`	# `getSid( )` Return the session ID Return the session ID Returns `string` The session ID
`public mixed`	# `read( string $name )` Read Session information for the given index Read Session information for the given index Parameters `$name` `string` $name The name of the index to read Returns `mixed` The value stored in $name of the session, or an empty string.
`public`	# `write( string $name, mixed $value )` Writes the given session information to the given index Writes the given session information to the given index Parameters `$name` `string` $name The index to write to `$value` `mixed` $value The value to write
`public`	# `clear( string $name = null )` Unsets the value of a given session variable, or the entire session array of all values Unsets the value of a given session variable, or the entire session array of all values Parameters `$name` `string` $name The session variable to unset
`public`	# `setSessionCookie( string $path = "", string $domain = "", boolean $secure = false )` Set the session cookie Set the session cookie Parameters `$path` `string` $path The path for this cookie, default is the current URI `$domain` `string` $domain The domain that the cookie is available to, default is the current domain `$secure` `boolean` $secure Whether or not the cookie should be transmitted over a secure connection from the client
`public`	# `keepAliveSessionCookie( string $path = "", string $domain = "", boolean $secure = false )` Updates the session cookie expiration date so that it remains active without expiring Updates the session cookie expiration date so that it remains active without expiring Parameters `$path` `string` $path The path for this cookie, default is the current URI `$domain` `string` $domain The domain that the cookie is available to, default is the current domain `$secure` `boolean` $secure Whether or not the cookie should be transmitted over a secure connection from the client
`public`	# `clearSessionCookie( string $path = "", string $domain = "", boolean $secure = false )` Deletes the session cookie Deletes the session cookie Parameters `$path` `string` $path The path for this cookie, default is the current URI `$domain` `string` $domain The domain that the cookie is available to, default is the current domain `$secure` `boolean` $secure Whether or not the cookie should be transmitted over a secure connection from the client
`private`	# `sessionSet( integer $ttl, string $tbl, string $tblid, string $tblexpire, string $tblvalue, mixed $session_name )` Set session handler callback methods and start the session Set session handler callback methods and start the session Parameters `$ttl` `integer` $ttl Time to Live (seconds) `$tbl` `string` $tbl Name of the session table `$tblid` `string` $tblid Name of the session ID field `$tblexpire` `string` $tblexpire Name of the session expire date field `$tblvalue` `string` $tblvalue Name of the session value field `$session_name`
`private`	# `setCsid( string $csid )` Sets the cookie session ID Sets the cookie session ID Parameters `$csid` `string` $csid The cookie session ID
`private`	# `setKeepAlive( string $csid )` Reawake the session using the given cookie session id Reawake the session using the given cookie session id Parameters `$csid` `string` $cisd The cookie session ID
`private`	# `sessionOpen( string $session_path, string $session_name )` Open the given session. Not implemented, included only for compatibility Open the given session. Not implemented, included only for compatibility Parameters `$session_path` `string` $session_path The path to the session `$session_name` `string` $session_name The name of the session
`private boolean`	# `sessionClose( )` Close a session. Not implemented, included only for campaitibility Close a session. Not implemented, included only for campaitibility Returns `boolean` True, always
`private string`	# `sessionSelect( integer $sid )` Reads the session data from the database Reads the session data from the database Parameters `$sid` `integer` $sid Session ID Returns `string`
`private`	# `sessionWrite( string $sid, string $value )` Writes the session data to the database. If that SID already exists, then the existing data will be updated. Writes the session data to the database. If that SID already exists, then the existing data will be updated. Parameters `$sid` `string` $sid The session ID `$value` `string` $value The value to write to the session
`private`	# `sessionDestroy( string $sid )` Deletes all session information for the given session ID Deletes all session information for the given session ID Parameters `$sid` `string` $sid The session ID
`private`	# `sessionGarbageCollect( integer $lifetime )` Deletes all sessions that have expired. Deletes all sessions that have expired. Parameters `$lifetime` `integer` $lifetime TTL of the session

Magic methods summary

Properties summary

`private mixed`	`$Record`	#
`private mixed`	`$ttl`	#
`private mixed`	`$tbl`	#
`private mixed`	`$tblid`	#
`private mixed`	`$tblexpire`	#
`private mixed`	`$tblvalue`	#
`private mixed`	`$csid`	#
`private mixed`	`$sid`	#
`private static integer`	`$instances`	#