\Fuman_Client

Fuman_Client

Summary

Methods

Properties

Constants

__construct()
init()
getAcl()
getUser()
hasUser()
hasUserActiveRole()
setUser()
synchronizeSessionData()
getDeviceClass()
setDeviceClass()
setCookie()
getCookie()
hasCookie()
logOut()
getHttpLanguage()
hasHttpLanguage()
getDefaultBackendInterfaceLanguage()
getBackendInterfaceLanguages()
getBackendInterfaceLanguage()
setBackendInterfaceLanguage()
getTableContentDefaultLanguage()
getTableContentTranslationLanguages()
getFrontendInterfaceLanguages()
getFrontendInterfaceLanguage()
setFrontendInterfaceLanguage()
getContentDefaultLanguage()
getContentTranslationLanguages()
hasContentTranslationLanguage()
hasContentTranslationLanguages()
getAllContentTranslationLanguages()
hasFrontendFlag()
determineDeviceClass()

No public properties found

COOKIE_PREFIX
SESSION_CONTAINER_NAME

_setCookie()

$_defaultAcl
$_user
$_sessionRegenerated
$_deviceClass
$_httpLanguage
$_backendInterfaceLanguage
$_backendInterfaceLanguages
$_frontendInterfaceLanguage
$_frontendInterfaceLanguages
$_contentDefaultLanguage
$_contentTranslationLanguages
$_allContentTranslationLanguages
$_translationLanguage

N/A

No private methods found

$_cookiesSet

N/A

File: library/Fuman/Client.php
Package: Default
Class hierarchy: \Fuman_Client

Constants

COOKIE_PREFIX

COOKIE_PREFIX

SESSION_CONTAINER_NAME

SESSION_CONTAINER_NAME

Session container name

Properties

$_defaultAcl

$_defaultAcl : \Fuman_Acl

The default access control list

Type

\Fuman_Acl

$_user

$_user : \Fuman_Auth_User

User

Type

\Fuman_Auth_User

$_sessionRegenerated

$_sessionRegenerated : boolean

Flag that we don't regenerate session id multiple times per request

Type

boolean

$_deviceClass

$_deviceClass : \stdClass

Device class name

Type

\stdClass

$_httpLanguage

$_httpLanguage : null|string

Type

null|string

$_backendInterfaceLanguage

$_backendInterfaceLanguage : string

The current interface language

Type

string

$_backendInterfaceLanguages

$_backendInterfaceLanguages : array|null

The interface (browser) languages

Type

array|null

$_frontendInterfaceLanguage

$_frontendInterfaceLanguage : string

The current interface langue

Type

string

$_frontendInterfaceLanguages

$_frontendInterfaceLanguages : array|null

The interface (browser) languages

Type

array|null

$_contentDefaultLanguage

$_contentDefaultLanguage : string

The default content language

Type

string

$_contentTranslationLanguages

$_contentTranslationLanguages : array|null

Translation languages for content

Type

array|null

$_allContentTranslationLanguages

$_allContentTranslationLanguages : array|null

All translation languages for content

Type

array|null

$_translationLanguage

$_translationLanguage : integer

Type

integer

$_cookiesSet

$_cookiesSet :

Type

Methods

__construct()

__construct()

Constructor

init()

init()

Constructor

getAcl()

getAcl() : \Fuman_Acl

Returns {@link Fuman_Acl}

Returns

\Fuman_Acl

getUser()

getUser() : \Fuman_Auth_User

Get {@link Fuman_Auth_User}

Returns

\Fuman_Auth_User

hasUser()

hasUser() : boolean

Returns true when {@link Fuman_Auth_User} is set.

Returns

boolean

hasUserActiveRole()

hasUserActiveRole() : boolean

Returns true if {@link Fuman_Auth_User} has a active {@link Fuman_Auth_Role}

Returns

boolean

setUser()

setUser(\Fuman_Auth_User  $user = null) : void

Set {@link Fuman_Auth_User}

Parameters

\Fuman_Auth_User

$user

synchronizeSessionData()

synchronizeSessionData()

Synchronize the Session Data with the active user record

getDeviceClass()

getDeviceClass() : string

Returns device class (desktop,mobile,tablet,wap,crawler)

Returns

string

setDeviceClass()

setDeviceClass(string  $class)

Set device class

Parameters

string

$class

setCookie()

setCookie(string  $name, string  $value, null|integer  $maxAge = null) : void

Sets cookie (includes headers sent check)

Parameters

string	$name
string	$value
null\|integer	$maxAge	Max age of cookie in seconds (0 expire at end of session, default 90 days)

getCookie()

getCookie(string  $name) : null

Gets cookie

Parameters

string

$name

Returns

null

hasCookie()

hasCookie(string  $name) : boolean

Has cookie

Parameters

string

$name

Returns

boolean

logOut()

logOut() : void

Logs out and deletes session

getHttpLanguage()

getHttpLanguage() : null|string

Gets http language

Returns

null|string

hasHttpLanguage()

hasHttpLanguage() : boolean

Has http language

Returns

boolean

getDefaultBackendInterfaceLanguage()

getDefaultBackendInterfaceLanguage() : string

Gets default admin interface language

Returns

string

getBackendInterfaceLanguages()

getBackendInterfaceLanguages() : array

Gets an array of supported admin interface languages

Returns

array

getBackendInterfaceLanguage()

getBackendInterfaceLanguage() : string

Gets admin interface language (validated against the configured languages)

Returns

string

setBackendInterfaceLanguage()

setBackendInterfaceLanguage(string  $language) : boolean

Sets admin interface language

Parameters

string

$language

Returns

boolean —

true if accepted

getTableContentDefaultLanguage()

getTableContentDefaultLanguage(\Fuman_Table  $table) : string

Gets default content language for given table

Parameters

\Fuman_Table

$table

Returns

string

getTableContentTranslationLanguages()

getTableContentTranslationLanguages(\Fuman_Table  $table) : array

Gets translation languages for given table

Parameters

\Fuman_Table

$table

Returns

array

getFrontendInterfaceLanguages()

getFrontendInterfaceLanguages() : array

Gets an array of supported frontend languages

Returns

array

getFrontendInterfaceLanguage()

getFrontendInterfaceLanguage() : string

Gets frontend language (validated against the configured languages)

Returns

string

setFrontendInterfaceLanguage()

setFrontendInterfaceLanguage(string  $language) : boolean

Sets frontend language

Parameters

string

$language

Returns

boolean —

true if accepted

getContentDefaultLanguage()

getContentDefaultLanguage() : string

Gets the default content language

Returns

string

getContentTranslationLanguages()

getContentTranslationLanguages() : array

Gets the translation languages

Returns

array

hasContentTranslationLanguage()

hasContentTranslationLanguage(string  $language) : boolean

Is the language defined as content language

Parameters

string

$language

Returns

boolean

hasContentTranslationLanguages()

hasContentTranslationLanguages() : boolean

Are any content translation languages defined

Returns

boolean

getAllContentTranslationLanguages()

getAllContentTranslationLanguages() : \array(string)

Get all content translation languages (including default on first position)

Returns

\array(string)

hasFrontendFlag()

hasFrontendFlag() : boolean

Has frontend flag

Returns

boolean

determineDeviceClass()

determineDeviceClass(string  $userAgent) : string

Determine device class

Parameters

string

$userAgent

Returns

string

static