class OAuth2ServerClient in OAuth2 Server 7

Entity class representing the oauth2_server_client entity type.

Hierarchy

• class \Entity implements EntityInterface
  • class \OAuth2ServerClient

1 string reference to 'OAuth2ServerClient'

oauth2_server_entity_info in ./oauth2_server.module

Implements hook_entity_info().

File

includes/oauth2_server.client.inc, line 6

class OAuth2ServerClient extends Entity {

  /**
   * The machine name of the parent server.
   *
   * @var string
   */
  public $server;

  /**
   * The label of the client.
   *
   * @var string
   */
  public $label;

  /**
   * The client key.
   *
   * @var string
   */
  public $client_key;

  /**
   * The client secret.
   *
   * @var string
   */
  public $client_secret;

  /**
   * The public key.
   *
   * Used to decode the JWT when the "JWT bearer" grant type is used.
   *
   * @var string
   */
  public $public_key;

  /**
   * The absolute URI to redirect to after authorization.
   *
   * @var string
   */
  public $redirect_uri;

  /**
   * Whether authorization should be completed without user confirmation.
   *
   * @var boolean
   */
  public $automatic_authorization = FALSE;

  /**
   * An array of settings.
   *
   * Used to override server-level settings.
   *
   * @var array
   */
  public $settings = array(
    'override_grant_types' => FALSE,
    'allow_implicit' => FALSE,
    'grant_types' => array(
      'authorization_code' => 'authorization_code',
      'refresh_token' => 'refresh_token',
    ),
  );
  public function __construct($values = array()) {
    parent::__construct($values, 'oauth2_server_client');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
OAuth2ServerClient::$automatic_authorization	public	property	Whether authorization should be completed without user confirmation.
OAuth2ServerClient::$client_key	public	property	The client key.
OAuth2ServerClient::$client_secret	public	property	The client secret.
OAuth2ServerClient::$label	public	property	The label of the client.
OAuth2ServerClient::$public_key	public	property	The public key.
OAuth2ServerClient::$redirect_uri	public	property	The absolute URI to redirect to after authorization.
OAuth2ServerClient::$server	public	property	The machine name of the parent server.
OAuth2ServerClient::$settings	public	property	An array of settings.
OAuth2ServerClient::__construct	public	function	Overrides Entity::__construct