Elgg  Version 1.10
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
} 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
} 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
} 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 36 of file MockSessionStorage.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Http\MockSessionStorage::__construct (   $name = 'MOCKSESSID')

Constructor.

Parameters
string$nameSession name

Definition at line 58 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 187 of file MockSessionStorage.php.

◆ clear()

Elgg\Http\MockSessionStorage::clear ( )

{Clears all attributes.

Returns
void
}

Implements Elgg\Http\SessionStorage.

Definition at line 226 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 150 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 167 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 113 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 131 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 157 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 106 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
}

Implements Elgg\Http\SessionStorage.

Definition at line 83 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 210 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 197 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
}

Implements Elgg\Http\SessionStorage.

Definition at line 96 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 177 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 120 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 138 of file MockSessionStorage.php.

◆ start()

Elgg\Http\MockSessionStorage::start ( )

{Starts the session.

Returns
boolean True if started.
Exceptions
}

Implements Elgg\Http\SessionStorage.

Definition at line 65 of file MockSessionStorage.php.

Member Data Documentation

◆ $closed

Elgg\Http\MockSessionStorage::$closed = false
protected

Definition at line 42 of file MockSessionStorage.php.

◆ $data

Elgg\Http\MockSessionStorage::$data = array()
protected

Definition at line 51 of file MockSessionStorage.php.

◆ $id

Elgg\Http\MockSessionStorage::$id = ''
protected

Definition at line 45 of file MockSessionStorage.php.

◆ $name

Elgg\Http\MockSessionStorage::$name
protected

Definition at line 48 of file MockSessionStorage.php.

◆ $started

Elgg\Http\MockSessionStorage::$started = false
protected

Definition at line 39 of file MockSessionStorage.php.

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