CoolCMS API

LoginProvider extends LoginProvider
in package

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_login_providers'
#[TableAlias]
'loginProvider'

Table of Contents

Properties

$active  : bool
$buttonHtmlClass  : string|null
$clientId  : string
$clientSecret  : string
$iconHtmlClass  : string|null
$id  : int|null
$key  : string
$scope  : string|null
$translations  : Collection

Methods

__construct()  : mixed
addTranslation()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getActive()  : bool
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getButtonHtmlClass()  : string|null
getClientId()  : string
getClientSecret()  : string
getIconHtmlClass()  : string|null
getId()  : int|null
getKey()  : string
getScope()  : string|null
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
isActive()  : bool
isPersisted()  : bool
removeTranslation()  : $this
setActive()  : $this
setButtonHtmlClass()  : $this
setClientId()  : $this
setClientSecret()  : $this
setIconHtmlClass()  : $this
setId()  : $this
setKey()  : $this
setScope()  : $this
setTranslations()  : $this
translationCollectionInit()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$active

protected bool $active = true
Attributes
#[Column]
$name: 'active'
$type: 'boolean'

$buttonHtmlClass

protected string|null $buttonHtmlClass = null
Attributes
#[Column]
$name: 'button_html_class'
$type: 'string'
$length: 255
$nullable: true

$clientId

protected string $clientId = ''
Attributes
#[Column]
$name: 'client_id'
$type: 'string'
$length: 255
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::Privileged
$update: Audience::Privileged

$clientSecret

protected string $clientSecret = ''
Attributes
#[Column]
$name: 'client_secret'
$type: 'string'
$length: 255
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::Privileged
$update: Audience::Privileged

$iconHtmlClass

protected string|null $iconHtmlClass = null
Attributes
#[Column]
$name: 'icon_html_class'
$type: 'string'
$length: 255
$nullable: true

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'login_provider_id'
$type: 'integer'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$key

protected string $key = ''
Attributes
#[Column]
$name: '`key`'
$type: 'string'
$length: 255

$scope

protected string|null $scope = null
Attributes
#[Column]
$name: 'scope'
$type: 'text'
$nullable: true

$translations

protected Collection $translations
Attributes
#[OneToMany]
$targetEntity: \App\UI\Api\System\Models\Entities\LoginProviderText::class
$mappedBy: 'parent'
$cascade: ["persist", "remove"]
$orphanRemoval: true
$fetch: "LAZY"

Methods

__construct()

public __construct([int|null $id = null ][, string $key = '' ][, string $clientId = '' ][, string $clientSecret = '' ][, string|null $scope = null ][, string|null $buttonHtmlClass = null ][, string|null $iconHtmlClass = null ][, bool $active = true ][, Collection $translations = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$key : string = ''
$clientId : string = ''
$clientSecret : string = ''
$scope : string|null = null
$buttonHtmlClass : string|null = null
$iconHtmlClass : string|null = null
$active : bool = true
$translations : Collection = new ArrayCollection()

addTranslation()

public addTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getButtonHtmlClass()

public getButtonHtmlClass() : string|null
Return values
string|null

getClientId()

public getClientId() : string
Return values
string

getClientSecret()

public getClientSecret() : string
Return values
string

getIconHtmlClass()

public getIconHtmlClass() : string|null
Return values
string|null

getScope()

public getScope() : string|null
Return values
string|null

getTranslation()

public getTranslation(int $langId) : TTranslation|null
Parameters
$langId : int
Return values
TTranslation|null

getTranslations()

public getTranslations() : Collection<int, TTranslation>
Return values
Collection<int, TTranslation>

removeTranslation()

public removeTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

setActive()

public setActive(bool $active) : $this
Parameters
$active : bool
Return values
$this

setButtonHtmlClass()

public setButtonHtmlClass(string|null $buttonHtmlClass) : $this
Parameters
$buttonHtmlClass : string|null
Return values
$this

setClientId()

public setClientId(string $clientId) : $this
Parameters
$clientId : string
Return values
$this

setClientSecret()

public setClientSecret(string $clientSecret) : $this
Parameters
$clientSecret : string
Return values
$this

setIconHtmlClass()

public setIconHtmlClass(string|null $iconHtmlClass) : $this
Parameters
$iconHtmlClass : string|null
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setKey()

public setKey(string $key) : $this
Parameters
$key : string
Return values
$this

setScope()

public setScope(string|null $scope) : $this
Parameters
$scope : string|null
Return values
$this

setTranslations()

public setTranslations(Collection<int, TTranslation>|array<int, TTranslation> $translations) : $this
Parameters
$translations : Collection<int, TTranslation>|array<int, TTranslation>
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results