Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Public Member Functions | List of all members
AfsConfigurationBase Class Reference

Configuration base class for AFS configuration classes. More...

Inheritance diagram for AfsConfigurationBase:
AfsAcpConfiguration AfsHelperConfiguration

Public Member Functions

 __construct ()
 Constructs new configuration class with default parameters set.
Helper format
 get_helper_format ()
 Retrieves reply helper format.
 is_array_format ()
 Checks whether helper format is set to ARRAYS.
 is_helper_format ()
 Checks whether helper format is set to HELPERS.
 set_helper_format ($format)
 Defines new reply helper format.
User and Session identifiers
 get_user_session_manager ()
 Restrievs user and session id manager.
 set_user_sessionmanager (AfsUserSessionManager $user_session_mgr)
 Defines new user and session id manager.

Detailed Description

Configuration base class for AFS configuration classes.

Member Function Documentation

get_helper_format ( )

Retrieves reply helper format.

Returns
helper format (AfsHelperFormat::ARRAYS or AfsHelperFormat::HELPERS (default))
get_user_session_manager ( )

Restrievs user and session id manager.

Returns
Manager for user and session id.
is_array_format ( )

Checks whether helper format is set to ARRAYS.

Returns
True when helper format equals AfsHelperFormat::ARRAYS.
is_helper_format ( )

Checks whether helper format is set to HELPERS.

Returns
True when helper format equals AfsHelperFormat::HELPERS.
set_helper_format (   $format)

Defines new reply helper format.

Parameters
$format[in] new format to set (see AfsHelperFormat)
Returns
current instance.
Exceptions
InvalidArgumentExceptionwhen provided format is invalid.
set_user_sessionmanager ( AfsUserSessionManager  $user_session_mgr)

Defines new user and session id manager.

Parameters
$user_session_mgr[in] new manager for user and session id.
Returns
current instance.