OpenEstate-PHP-Export 2.0-beta2 API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\SessionPhpSession

A session store, that uses PHP sessions.

Summary

Methods
Properties
Constants
__construct()
__destruct()
addFavorite()
clear()
get()
getCaptcha()
getEnvironment()
getFavorites()
getFavoriteOrder()
getFavoriteOrderDirection()
getFavoritePage()
getFavoriteView()
getLanguage()
getListingFilters()
getListingOrder()
getListingOrderDirection()
getListingPage()
getListingView()
init()
isFavorite()
removeFavorite()
set()
setCaptcha()
setFavoriteOrder()
setFavoriteOrderDirection()
setFavoritePage()
setFavoriteView()
setLanguage()
setListingFilters()
setListingOrder()
setListingOrderDirection()
setListingPage()
setListingView()
write()
No public properties found
No constants found
No protected methods found
$env
$root
N/A
No private methods found
No private properties found
N/A

Properties

$root

$root : string

Name of the root variable within $_SESSION, that holds the session data.

Type

string

Methods

__construct()

__construct(\OpenEstate\PhpExport\Environment  $env, string  $root = null)

PhpSession constructor.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment
string $root

name of the root variable within $_SESSION

__destruct()

__destruct()

AbstractSession destructor.

addFavorite()

addFavorite(string  $objectId)

Add an object to the favorites.

Parameters

string $objectId

ID of the object to add

clear()

clear() : void

Remove session from the backend store.

get()

get(string  $key) : mixed|null

Get a value from session store.

Parameters

string $key

variable name in session store

Returns

mixed|null —

requested value or null, if not available in session store

getCaptcha()

getCaptcha() : string|null

Get captcha hash value.

Returns

string|null —

captcha hash value or null, if not specified

getFavorites()

getFavorites() : array

Get list of favorite object ID's.

Returns

array —

array of object ID's

getFavoriteOrder()

getFavoriteOrder() : string|null

Get name of ordering for the favorite view.

Returns

string|null —

internal name of current ordering or null, if not specified

getFavoriteOrderDirection()

getFavoriteOrderDirection() : string|null

Get direction of ordering for the favorite view.

Returns

string|null —

current ordering direction or null, if not specified

getFavoritePage()

getFavoritePage() : integer|null

Get page number for the favorite view.

Returns

integer|null —

page number or null, if not specified

getFavoriteView()

getFavoriteView() : string|null

Get view for the favorite view.

Returns

string|null —

name of the view or null, if not specified

getLanguage()

getLanguage() : string|null

Get current language from session.

Returns

string|null —

current language or null, if not specified

getListingFilters()

getListingFilters() : array

Get filter values for the listing view.

Returns

array —

array of filter values

getListingOrder()

getListingOrder() : string|null

Get name of ordering for the listing view.

Returns

string|null —

internal name of current ordering or null, if not specified

getListingOrderDirection()

getListingOrderDirection() : string|null

Get direction of ordering for the listing view.

Returns

string|null —

current ordering direction or null, if not specified

getListingPage()

getListingPage() : integer|null

Get page number for the listing view.

Returns

integer|null —

page number or null, if not specified

getListingView()

getListingView() : string|null

Get view for the listing view.

Returns

string|null —

name of the view or null, if not specified

init()

init() : void

Initialize the session.

isFavorite()

isFavorite(string  $objectId) : boolean

Test, if an object was added to favorites.

Parameters

string $objectId

ID of the object to lookup

Returns

boolean —

true, if the object was added to favorites

removeFavorite()

removeFavorite(string  $objectId)

Remove an object from the favorites.

Parameters

string $objectId

ID of the object to remove

set()

set(string  $key, mixed|null  $value)

Set a value in session store.

Parameters

string $key

variable name in session store
mixed|null $value

value to save or null, to remove the value from session store

setCaptcha()

setCaptcha(  $captcha)

Set captcha hash value.

Parameters

$captcha

setFavoriteOrder()

setFavoriteOrder(  $order)

Set name of ordering for the favorite view.

Parameters

$order

setFavoriteOrderDirection()

setFavoriteOrderDirection(  $direction)

Set direction of ordering for the favorite view.

Parameters

$direction

setFavoritePage()

setFavoritePage(  $page)

Set page number for the favorite view.

Parameters

$page

setFavoriteView()

setFavoriteView(  $view)

Set view for the favorite view.

Parameters

$view

setLanguage()

setLanguage(  $language)

Set current language.

Parameters

$language

setListingFilters()

setListingFilters(  $filters)

Set filter values for the listing view.

Parameters

$filters

setListingOrder()

setListingOrder(  $order)

Set name of ordering for the listing view.

Parameters

$order

setListingOrderDirection()

setListingOrderDirection(  $direction)

Set direction of ordering for the listing view.

Parameters

$direction

setListingPage()

setListingPage(  $page)

Set page number for the listing view.

Parameters

$page

setListingView()

setListingView(  $view)

Set view for the listing view.

Parameters

$view

write()

write() : void

Write session to the backend store.