Overview

Namespaces

  • Charcoal
    • Object
    • User
      • Acl

Classes

  • AbstractUser
  • Authenticator
  • Authorizer
  • AuthToken
  • AuthTokenMetadata
  • GenericUser

Interfaces

  • UserInterface
  • Overview
  • Namespace
  • Class

Class AuthTokenMetadata

User Auth Token metadata

Charcoal\Model\ModelMetadata
Extended by Charcoal\User\AuthTokenMetadata
Namespace: Charcoal\User
Located at Charcoal/User/AuthTokenMetadata.php
Methods summary
public array
# defaults( )

Returns

array

See

\Charcoal\Config\ConfigInterface::defaults()
public Charcoal\User\AuthTokenMetadata
# setEnabled( boolean $enabled )

Parameters

$enabled
The enabled flag.

Returns

Charcoal\User\AuthTokenMetadata
Chainable
public boolean
# enabled( )

Returns

boolean
public Charcoal\User\AuthTokenMetadata
# setCookieName( string $name )

Parameters

$name
The cookie name.

Returns

Charcoal\User\AuthTokenMetadata
Chainable

Throws

InvalidArgumentException
If the cookie name is not a string.
public string
# cookieName( )

Returns

string
public Charcoal\User\AuthTokenMetadata
# setCookieDuration( string $duration )

Parameters

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

Returns

Charcoal\User\AuthTokenMetadata
Chainable

Throws

InvalidArgumentException
If the cookie name is not a string.
public string
# cookieDuration( )

Returns

string
public Charcoal\User\AuthTokenMetadata
# setHttpsOnly( boolean $httpsOnly )

Parameters

$httpsOnly
The "https only" flag.

Returns

Charcoal\User\AuthTokenMetadata
Chainable
public boolean
# httpsOnly( )

Returns

boolean
API documentation generated by ApiGen