Class Session

Session.

Namespace: ICanBoogie
Located at Session.php

Methods summary


				
				 public static
				
				

				exists( void )
				

				: boolean

Checks if a session identifier can be found to retrieve a session.


				
				 public static
				
				

				get_session( ICanBoogie\Core $app )
				

				: ICanBoogie\Session

Returns a Session instance.


				
				 public 
				
				

				__construct( array $options = [] )

Constructor.

In order to circumvent session fixation and session hijacking, the user agent hash is attached to the session. A previous session can only be restored if the user agent hash match.

The session is destroyed when the values don't match and the "location" header is set to request a reload.

Parameters

$options


				
				 protected 
				
				

				prepare_options( array $options )
				

				: array

Prepare session options.


				
				 protected 
				
				

				apply_options( array $options )

Applies options.


				
				 protected 
				
				

				apply_use_trans_id(  $use_trans_sid )

Applies session.use_trans_sid.


				
				 public 
				
				

				regenerate_id( boolean $delete_old_session = false )
				

				: boolean|null

Regenerates the id of the session.


				
				 public 
				
				

				regenerate_token( void )
				

				: string

Regenerates the session token.


				
				 public 
				&
				

				__get(  $property )


				
				 public 
				
				

				__set(  $property,  $value )


				
				 public 
				
				

				__isset(  $property )


				
				 public 
				
				

				__unset(  $property )

Properties summary


				
				public static 
				

				
$defaults				

				: array

[

    'id' => null,
    'name' => 'ICanBoogie',
    'domain' => null,
    'use_cookies' => true,
    'use_only_cookies' => true,
    'use_trans_sid' => false,
    'cache_limiter' => null,
    'module_name' => 'files'

]

Magic properties


				
				public  
				

				
$remote_agent_hash				

				: string

The remote user agent hash of the request that created the session.


				
				public  
				

				
$icanboogie_logger				

				: ICanBoogie\Logger


				
				public  
				

				
$token				

				: string

A token that can be used to prevent cross-site request forgeries.