Index | Flarum SSO PHP Plugin API Docs

A

$Core#actions — Property in class Core
$Groups#actions — Property in class Groups
$Flarum#api — Property in class Flarum
Addons — Class in namespace Maicol07\SSO\Traits
Addons::action_hook() — Method in class Addons
$User#attributes — Property in class User
Attributes — Class in namespace Maicol07\SSO\User
$Attributes#avatarUrl — Property in class Attributes
Auth — Class in namespace Maicol07\SSO\User\Traits

B

Basic — Class in namespace Maicol07\SSO\Traits
$Attributes#bio — Property in class Attributes
$Attributes#blocksPd — Property in class Attributes

C

Core — Class in namespace Maicol07\SSO\Addons
Groups::createGroup() — Method in class Groups
Cookies — Class in namespace Maicol07\SSO\Traits
$Attributes#commentCount — Property in class Attributes
$Attributes#canEdit — Property in class Attributes
$Attributes#canDelete — Property in class Attributes
$Attributes#canSuspend — Property in class Attributes
$Attributes#canViewBio — Property in class Attributes
$Attributes#canEditBio — Property in class Attributes
$Attributes#canSpamblock — Property in class Attributes
$Attributes#cannotBeDirectMessaged — Property in class Attributes
$Attributes#canBandIP — Property in class Attributes
$Attributes#canViewWarnings — Property in class Attributes
$Attributes#canManageWarnings — Property in class Attributes
$Attributes#canDeleteWarnings — Property in class Attributes

D

Basic::delete() — Method in class Basic: Deletes a user from Flarum database. Generally, you should use this method when an user successfully deleted his account from your SSO system (or main website)
Cookies::deleteRememberTokenCookie() — Method in class Cookies
Cookies::deleteSessionTokenCookie() — Method in class Cookies
Cookies::deleteLogoutCookie() — Method in class Cookies
User::delete() — Method in class User
$Attributes#displayName — Property in class Attributes
$Attributes#discussionCount — Property in class Attributes

E

$Attributes#email — Property in class Attributes

F

$Core#filters — Property in class Core
$Core#flarum — Property in class Core
Flarum — Class in namespace Maicol07\SSO
Addons::filter_hook() — Method in class Addons
User::fetch() — Method in class User

G

Groups — Class in namespace Maicol07\SSO\Addons
Flarum::getUsersList() — Method in class Flarum
Cookies::generateCookie() — Method in class Cookies
User::getAttributes() — Method in class User
User::getRelationships() — Method in class User
$Relationships#groups — Property in class Relationships

H

$Core#hooks — Property in class Core

I

Flarum::isSessionRemembered() — Method in class Flarum
Addons::isAddonLoaded() — Method in class Addons
$User#id — Property in class User
$User#isAdmin — Property in class User
$Attributes#isBanned — Property in class Attributes

J

$Attributes#joinTime — Property in class Attributes

L

Core::load() — Method in class Core
Flarum::logout() — Method in class Flarum
Addons::loadAddon() — Method in class Addons
Basic::login() — Method in class Basic
Auth::login() — Method in class Auth

M

MissingRequiredAddonException — Class in namespace Maicol07\SSO\Exceptions

N

$Attributes#nickname — Property in class Attributes

P

$Flarum#password_token — Property in class Flarum
$Attributes#password — Property in class Attributes

R

$Core#required — Property in class Core
$Flarum#root_domain — Property in class Flarum
Flarum::redirect() — Method in class Flarum: Redirects the user to your Flarum instance
$User#relationships — Property in class User
Relationships — Class in namespace Maicol07\SSO\User

S

Groups::setGroups() — Method in class Groups: Sets groups to a user
Addons::setAddonProperties() — Method in class Addons
Cookies::setRememberTokenCookie() — Method in class Cookies
Cookies::setSessionTokenCookie() — Method in class Cookies
Cookies::setLogoutCookie() — Method in class Cookies
Auth::signup() — Method in class Auth

T

$User#type — Property in class User
Attributes::toArray() — Method in class Attributes
Relationships::toArray() — Method in class Relationships

U

Core::unload() — Method in class Core
$Flarum#url — Property in class Flarum
Flarum::user() — Method in class Flarum
Addons::unloadAddon() — Method in class Addons
Basic::update() — Method in class Basic: Updates a user. Warning! User needs to be find with username or email, so one of those two has to be the old one
User — Class in namespace Maicol07\SSO
User::update() — Method in class User: Updates a user. If user id is not set, user will be fetched. Warning! User needs to be found with username or email, so one of those two has to be the old one
$Attributes#username — Property in class Attributes
$Attributes#usernameHistory — Property in class Attributes

V

$Flarum#verify — Property in class Flarum
$Attributes#visibleWarningCount — Property in class Attributes

_

Core::__construct() — Method in class Core
Flarum::__construct() — Method in class Flarum
User::__construct() — Method in class User