class SudoModeService implements SudoModeServiceInterface (View source)

Traits

Provides extensions to this object to integrate it with standard config API methods.

Constants

private SUDO_MODE_SESSION_KEY

The session key that is used to store the timestamp for when sudo mode was last activated

Config options

lifetime_minutes int

The lifetime that sudo mode authorization lasts for, in minutes.

Properties

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
bool
check(Session $session)

Checks the current session to see if sudo mode was activated within the last section of lifetime allocation.

public
bool
activate(Session $session)

Register activated sudo mode permission in the provided session, which lasts for the configured lifetime.

public
int
getLifetime()

How long the sudo mode activation lasts for in minutes.

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

bool check(Session $session)

Checks the current session to see if sudo mode was activated within the last section of lifetime allocation.

Parameters

Session $session

Return Value

bool

bool activate(Session $session)

Register activated sudo mode permission in the provided session, which lasts for the configured lifetime.

Parameters

Session $session

Return Value

bool

int getLifetime()

How long the sudo mode activation lasts for in minutes.

Return Value

int