Class Quform_Session

Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Session.php

Methods summary
`protected string`	# `getTableName( )` Get the name of the session table with the WP prefix added Get the name of the session table with the WP prefix added Returns string
`protected string`	# `read( string $sessionId )` Get the serialized session data Get the serialized session data Parameters `$sessionId` Returns string
`protected`	# `write( string $sessionId, string $data )` Write the serialized session data Write the serialized session data Parameters `$sessionId` `$data`
`protected`	# `destroy( string $sessionId )` Destroy the session with the given ID Destroy the session with the given ID Parameters `$sessionId`
`public`	# `gc( )` Garbage collection Garbage collection
`public`	# `setId( $id )` Set the session ID Set the session ID Parameters `$id`
`public string`	# `getId( )` Get the session ID Get the session ID Returns string
`public boolean`	# `isValidId( string $id )` Determine if this is a valid session ID. Determine if this is a valid session ID. Parameters `$id` Returns boolean
`protected string`	# `generateSessionId( )` Get a new, random session ID Get a new, random session ID Returns string
`public boolean`	# `start( )` Start the session Start the session Returns boolean
`public`	# `setSessionCookie( )` Set the session cookie Set the session cookie
`protected`	# `setSessionIdCookie( string $id )` Set the cookie to store the session ID Set the cookie to store the session ID Parameters `$id`
`public`	# `save( )` Save the session data, only if something has changed Save the session data, only if something has changed
`public`	# `regenerateToken( )` Regenerate the CSRF token value Regenerate the CSRF token value
`public string`	# `getToken( )` Get the CSRF token value Get the CSRF token value Returns string
`public boolean`	# `has( string $key )` Does the session data contain the given key? Does the session data contain the given key? Parameters `$key` Returns boolean
`public mixed`	# `get( string\|null $key = null, mixed\|null $default = null )` Get the session data with the given key Get the session data with the given key Parameters `$key` The key within the session data `$default` The default to return if the key does not exist Returns mixed
`public`	# `set( string $key, mixed $value )` Set the session data with the given key Set the session data with the given key Parameters `$key` The key within the session data `$value` The value to set
`public`	# `put( string\|array $key, mixed\|null $value = null )` Put a key / value pair or array of key / value pairs into the session Put a key / value pair or array of key / value pairs into the session Parameters `$key` `$value`
`public`	# `forget( array\|string $keys )` Remove the item(s) with the given key(s) from the session Remove the item(s) with the given key(s) from the session Parameters `$keys`
`protected`	# `scheduleGc( )` Schedule the garbage collection task Schedule the garbage collection task
`protected`	# `unscheduleGc( )` Unschedule the garbage collection task Unschedule the garbage collection task
`public`	# `activate( )` On plugin activation, schedule the garbage collection task On plugin activation, schedule the garbage collection task
`public`	# `deactivate( )` On plugin deactivation, unschedule the garbage collection task and cleanup On plugin deactivation, unschedule the garbage collection task and cleanup
`public`	# `uninstall( )` On plugin uninstall, unschedule the garbage collection task and remove the session table On plugin uninstall, unschedule the garbage collection task and remove the session table
`public array`	# `dropTableOnSiteDeletion( array $tables )` Drop the session database table when a site is deleted Drop the session database table when a site is deleted Parameters `$tables` Returns array

Properties summary
`protected string`	`$name`	#
`protected string`	`$table` The name of the session table The name of the session table	#
`protected string`	`$id`	#
`protected array`	`$data` The session data The session data	# `array()`
`protected integer`	`$lifetime` The lifetime of the session in seconds The lifetime of the session in seconds	#
`protected boolean`	`$started` Is the session started? Is the session started?	# `false`
`protected boolean`	`$dirty` Has the session data been modified? Has the session data been modified?	# `false`

Classes

Interfaces

Class Quform_Session

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns