API Documentation
\
Charcoal
Object
User
Acl

\Charcoal\UserAuthTokenMetadata

User Auth Token metadata

Summary

Methods
Properties
Constants
defaults()
setEnabled()
enabled()
setCookieName()
cookieName()
setCookieDuration()
cookieDuration()
setHttpsOnly()
httpsOnly()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$enabled
$cookieName
$cookieDuration
$httpsOnly
N/A

Properties

$enabled

$enabled : boolean

Type

boolean

$cookieName

$cookieName : string

Type

string

$cookieDuration

$cookieDuration : string

Type

string

$httpsOnly

$httpsOnly : boolean

Type

boolean

Methods

defaults()

defaults() : array

Returns

array

setEnabled()

setEnabled(boolean  $enabled) : \Charcoal\User\AuthTokenMetadata

Parameters

boolean $enabled

The enabled flag.

Returns

\Charcoal\User\AuthTokenMetadata —

Chainable

enabled()

enabled() : boolean

Returns

boolean

setCookieName()

setCookieName(string  $name) : \Charcoal\User\AuthTokenMetadata

Parameters

string $name

The cookie name.

Throws

\InvalidArgumentException

If the cookie name is not a string.

Returns

\Charcoal\User\AuthTokenMetadata —

Chainable

cookieName()

cookieName() : string

Returns

string

setCookieDuration()

setCookieDuration(string  $duration) : \Charcoal\User\AuthTokenMetadata

Parameters

string $duration

The cookie duration, or duration. Ex: "15 days".

Throws

\InvalidArgumentException

If the cookie name is not a string.

Returns

\Charcoal\User\AuthTokenMetadata —

Chainable

cookieDuration()

cookieDuration() : string

Returns

string

setHttpsOnly()

setHttpsOnly(boolean  $httpsOnly) : \Charcoal\User\AuthTokenMetadata

Parameters

boolean $httpsOnly

The "https only" flag.

Returns

\Charcoal\User\AuthTokenMetadata —

Chainable

httpsOnly()

httpsOnly() : boolean

Returns

boolean