Flarum   See the code on Github

class Flarum

Traits

Cookies
See the code on Github
Addons
See the code on Github

Properties

$api See the code on Github
$password_token See the code on Github
$root_domain See the code on Github
$url See the code on Github
$verify See the code on Github

Methods

bool
setRememberTokenCookie(string $token)

No description

from Cookies
See the code on Github
Cookie
generateCookie(string $name, string $value = null, Carbon $expiry = null)

No description

from Cookies
See the code on Github
bool
deleteRememberTokenCookie()

No description

from Cookies
See the code on Github
bool
setSessionTokenCookie(string $token)

No description

from Cookies
See the code on Github
bool
deleteSessionTokenCookie()

No description

from Cookies
See the code on Github
bool
setLogoutCookie()

No description

from Cookies
See the code on Github
bool
deleteLogoutCookie()

No description

from Cookies
See the code on Github
int
loadAddon(string $addon)

No description

from Addons
See the code on Github
Addons
unloadAddon(string $addon)

No description

from Addons
See the code on Github
Addons
setAddonProperties(string $addon, array $attributes)

No description

from Addons
See the code on Github
bool
isAddonLoaded(string $addon)

No description

from Addons
See the code on Github
int|null
action_hook(string $tag)

No description

from Addons
See the code on Github
filter_hook(string $tag, $value)

No description

from Addons
See the code on Github
__construct(array $config)

No description

See the code on Github
bool
logout()

No description

See the code on Github
User
user(string $username = null)

No description

See the code on Github
Collection
getUsersList($filters = null)

No description

See the code on Github
isSessionRemembered(bool $remember = null)

No description

See the code on Github
void
redirect()

Redirects the user to your Flarum instance

See the code on Github

Details

in Cookies at line 11
bool setRememberTokenCookie(string $token)

Parameters

string $token

Return Value

bool

in Cookies at line 27
Cookie generateCookie(string $name, string $value = null, Carbon $expiry = null)

Parameters

string $name
string $value
Carbon $expiry

Return Value

Cookie

in Cookies at line 40
bool deleteRememberTokenCookie()

Return Value

bool

in Cookies at line 45
bool setSessionTokenCookie(string $token)

Parameters

string $token

Return Value

bool

in Cookies at line 50
bool deleteSessionTokenCookie()

Return Value

bool

in Cookies at line 55
bool setLogoutCookie()

Return Value

bool

in Cookies at line 61
bool deleteLogoutCookie()

Return Value

bool

in Addons at line 22
int loadAddon(string $addon)

Parameters

string $addon

Return Value

int

in Addons at line 34
Addons unloadAddon(string $addon)

Parameters

string $addon

Return Value

Addons

in Addons at line 50
Addons setAddonProperties(string $addon, array $attributes)

Parameters

string $addon
array $attributes

Return Value

Addons

in Addons at line 65
bool isAddonLoaded(string $addon)

Parameters

string $addon

Return Value

bool

in Addons at line 76
int|null action_hook(string $tag)

Parameters

string $tag

Return Value

int|null

in Addons at line 99
filter_hook(string $tag, $value)

Parameters

string $tag
$value

at line 55
__construct(array $config)

Parameters

array $config

at line 89
bool logout()

Return Value

bool

at line 101
User user(string $username = null)

Parameters

string $username

Return Value

User

at line 130
Collection getUsersList($filters = null)

Parameters

$filters

Return Value

Collection

at line 177
isSessionRemembered(bool $remember = null)

Parameters

bool $remember

at line 189
void redirect()

Redirects the user to your Flarum instance

Return Value

void