BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • Annotation
  • Application
  • AsyncJob
  • AuthProvider
  • Category
  • DateRange
  • ExternalAuth
  • History
  • Link
  • Location
  • ObjectCategory
  • ObjectEntity
  • ObjectPermission
  • ObjectProperty
  • ObjectRelation
  • Profile
  • Property
  • PropertyType
  • Publication
  • Relation
  • RelationType
  • Role
  • RolesUser
  • Stream
  • Tag
  • Translation
  • Tree
  • UserToken

Traits

  • JsonApiAdminTrait
  • JsonApiModelTrait

Class AuthProvider

AuthProvider Entity.

Cake\ORM\Entity
Extended by BEdita\Core\Model\Entity\AuthProvider
Namespace: BEdita\Core\Model\Entity
Since: 4.0.0
Located at Core/src/Model/Entity/AuthProvider.php

Methods summary

protected string
# _getSlug( )

Getter for slug.

Getter for slug.

Returns

string
public BEdita\Core\Model\Entity\Role[]
# getRoles( )

Get list of roles to be associated to users logging in with this auth provider.

Get list of roles to be associated to users logging in with this auth provider.

Returns

BEdita\Core\Model\Entity\Role[]
public boolean
# checkAuthorization( array $providerResponse, string $providerUsername )

Check auth providers credentials. Provider username MUST match external auth provider response.

Check auth providers credentials. Provider username MUST match external auth provider response.

Parameters

$providerResponse
Provider response in array format
$providerUsername
Provider username to match

Returns

boolean
True on success, false on failure

Properties summary

protected array $_accessible
# [ '*' => true, 'id' => false, ]

Magic properties

public integer $id
public string $name
public string $auth_class
public string $slug
public string $url
public string $params
public boolean $enabled
public Cake\I18n\Time $created
public Cake\I18n\Time $modified
public BEdita\Core\Model\Entity\ExternalAuth[] $external_auth
BEdita API doc | 4-cactus API documentation generated by ApiGen