Elgg  Version 1.9
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Elgg_Http_MockSessionStorage Class Reference
Inheritance diagram for Elgg_Http_MockSessionStorage:
Elgg_Http_SessionStorage

Public Member Functions

 __construct ($name='MOCKSESSID')
 Constructor. More...
 
 start ()
 {Starts the session.
Returns
boolean True if started.
Exceptions
RuntimeExceptionIf something goes wrong starting the session.
} More...
 
 regenerate ($destroy=false, $lifetime=null)
 {Regenerates id that represents this storage.This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.
Parameters
boolean$destroyDestroy session when regenerating?
integer$lifetimeSets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.
Returns
boolean True if session regenerated, false if error
Exceptions
RuntimeExceptionIf an error occurs while regenerating this storage
} More...
 
 save ()
 {Force the session to be saved and closed.This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it it should actually persist the session data if required.
Returns
void
Exceptions
RuntimeExceptionIf the session is saved without being started, or if the session is already closed.
} More...
 
 isStarted ()
 {Checks if the session is started.
Returns
boolean True if started, false otherwise.
} More...
 
 getId ()
 {Returns the session ID.
Returns
string The session ID or empty.
} More...
 
 setId ($id)
 {Sets the session ID.
Parameters
string$idSession string
Returns
void
} More...
 
 getName ()
 {Returns the session name.
Returns
string The session name.
} More...
 
 setName ($name)
 {Sets the session name.
Parameters
string$nameSession name.
Returns
void
} More...
 
 has ($name)
 {Checks if an attribute is defined.
Parameters
string$nameThe attribute name
Returns
boolean
} More...
 
 get ($name, $default=null)
 {Returns an attribute.
Parameters
string$nameThe attribute name
mixed$defaultThe default value if not found.
Returns
mixed
} More...
 
 set ($name, $value)
 {Sets an attribute.
Parameters
string$nameAttribute name
mixed$valueAttribute value
Returns
void
} More...
 
 all ()
 {Returns all attributes.
Returns
array Attributes
} More...
 
 replace (array $attributes)
 {Replaces all attributes.
Parameters
array$attributesAttributes
Returns
void
} More...
 
 remove ($name)
 {Removes an attribute.
Parameters
string$nameAttribute name
Returns
mixed The removed value
} More...
 
 clear ()
 {Clears all attributes.
Returns
void
} More...
 

Protected Member Functions

 generateId ()
 Generates a session ID. More...
 

Protected Attributes

 $started = false
 
 $closed = false
 
 $id = ''
 
 $name
 
 $data = array()
 

Detailed Description

Definition at line 35 of file MockSessionStorage.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg_Http_MockSessionStorage::__construct (   $name = 'MOCKSESSID')

Constructor.

Parameters
string$nameSession name

Definition at line 57 of file MockSessionStorage.php.

Member Function Documentation

◆ all()

Elgg_Http_MockSessionStorage::all ( )

{Returns all attributes.

Returns
array Attributes
}

Implements Elgg_Http_SessionStorage.

Definition at line 186 of file MockSessionStorage.php.

◆ clear()

Elgg_Http_MockSessionStorage::clear ( )

{Clears all attributes.

Returns
void
}

Implements Elgg_Http_SessionStorage.

Definition at line 225 of file MockSessionStorage.php.

◆ generateId()

Elgg_Http_MockSessionStorage::generateId ( )
protected

Generates a session ID.

This doesn't need to be particularly cryptographically secure since this is just a mock.

Returns
string

Definition at line 149 of file MockSessionStorage.php.

◆ get()

Elgg_Http_MockSessionStorage::get (   $name,
  $default = null 
)

{Returns an attribute.

Parameters
string$nameThe attribute name
mixed$defaultThe default value if not found.
Returns
mixed
}

Implements Elgg_Http_SessionStorage.

Definition at line 166 of file MockSessionStorage.php.

◆ getId()

Elgg_Http_MockSessionStorage::getId ( )

{Returns the session ID.

Returns
string The session ID or empty.
}

Implements Elgg_Http_SessionStorage.

Definition at line 112 of file MockSessionStorage.php.

◆ getName()

Elgg_Http_MockSessionStorage::getName ( )

{Returns the session name.

Returns
string The session name.
}

Implements Elgg_Http_SessionStorage.

Definition at line 130 of file MockSessionStorage.php.

◆ has()

Elgg_Http_MockSessionStorage::has (   $name)

{Checks if an attribute is defined.

Parameters
string$nameThe attribute name
Returns
boolean
}

Implements Elgg_Http_SessionStorage.

Definition at line 156 of file MockSessionStorage.php.

◆ isStarted()

Elgg_Http_MockSessionStorage::isStarted ( )

{Checks if the session is started.

Returns
boolean True if started, false otherwise.
}

Implements Elgg_Http_SessionStorage.

Definition at line 105 of file MockSessionStorage.php.

◆ regenerate()

Elgg_Http_MockSessionStorage::regenerate (   $destroy = false,
  $lifetime = null 
)

{Regenerates id that represents this storage.This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.

Parameters
boolean$destroyDestroy session when regenerating?
integer$lifetimeSets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.
Returns
boolean True if session regenerated, false if error
Exceptions
RuntimeExceptionIf an error occurs while regenerating this storage
}

Implements Elgg_Http_SessionStorage.

Definition at line 82 of file MockSessionStorage.php.

◆ remove()

Elgg_Http_MockSessionStorage::remove (   $name)

{Removes an attribute.

Parameters
string$nameAttribute name
Returns
mixed The removed value
}

Implements Elgg_Http_SessionStorage.

Definition at line 209 of file MockSessionStorage.php.

◆ replace()

Elgg_Http_MockSessionStorage::replace ( array  $attributes)

{Replaces all attributes.

Parameters
array$attributesAttributes
Returns
void
}

Implements Elgg_Http_SessionStorage.

Definition at line 196 of file MockSessionStorage.php.

◆ save()

Elgg_Http_MockSessionStorage::save ( )

{Force the session to be saved and closed.This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it it should actually persist the session data if required.

Returns
void
Exceptions
RuntimeExceptionIf the session is saved without being started, or if the session is already closed.
}

Implements Elgg_Http_SessionStorage.

Definition at line 95 of file MockSessionStorage.php.

◆ set()

Elgg_Http_MockSessionStorage::set (   $name,
  $value 
)

{Sets an attribute.

Parameters
string$nameAttribute name
mixed$valueAttribute value
Returns
void
}

Implements Elgg_Http_SessionStorage.

Definition at line 176 of file MockSessionStorage.php.

◆ setId()

Elgg_Http_MockSessionStorage::setId (   $id)

{Sets the session ID.

Parameters
string$idSession string
Returns
void
}

Implements Elgg_Http_SessionStorage.

Definition at line 119 of file MockSessionStorage.php.

◆ setName()

Elgg_Http_MockSessionStorage::setName (   $name)

{Sets the session name.

Parameters
string$nameSession name.
Returns
void
}

Implements Elgg_Http_SessionStorage.

Definition at line 137 of file MockSessionStorage.php.

◆ start()

Elgg_Http_MockSessionStorage::start ( )

{Starts the session.

Returns
boolean True if started.
Exceptions
RuntimeExceptionIf something goes wrong starting the session.
}

Implements Elgg_Http_SessionStorage.

Definition at line 64 of file MockSessionStorage.php.

Member Data Documentation

◆ $closed

Elgg_Http_MockSessionStorage::$closed = false
protected

Definition at line 41 of file MockSessionStorage.php.

◆ $data

Elgg_Http_MockSessionStorage::$data = array()
protected

Definition at line 50 of file MockSessionStorage.php.

◆ $id

Elgg_Http_MockSessionStorage::$id = ''
protected

Definition at line 44 of file MockSessionStorage.php.

◆ $name

Elgg_Http_MockSessionStorage::$name
protected

Definition at line 47 of file MockSessionStorage.php.

◆ $started

Elgg_Http_MockSessionStorage::$started = false
protected

Definition at line 38 of file MockSessionStorage.php.

The documentation for this class was generated from the following file:
Generated on Sat Nov 8 2025 00:00:30 for Elgg by doxygen 1.9.1