kernel/private/oauth/classes/restclient.php

Show:

inherited

Classes
- \ezpRestClient

Table of Contents

File containing the ezpRestClient class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\ezpRestClient
jump to top

Package: Default

Persistent object class representing a REST application.

Constants

 
                STATUS_DRAFT
                = 1

 
                STATUS_PUBLISHED
                = 0

Properties

string
                 $client_id= 'null'

Application client ID, as used over oAuth to authentify the application

Default valuenullDetails

Type: string

string
                 $client_secret= 'null'

Application client secret, as used over oAuth to authentify the application

Default valuenullDetails

Type: string

int
                 $created= 'null'

Application creation date, as a unix timestamp

Default valuenullDetails

Type: int

string
                 $description= 'null'

Application description

Default valuenullDetails

Type: string

string
                 $endpoint_uri= 'null'

Application client endpoint URI. Used to validate the redirection URI requested by the authorize call.

Default valuenullDetails

Type: string


                 $id= 'null'

Default valuenullDetails

Type: n/a

string
                 $name= 'null'

Application name

Default valuenullDetails

Type: string

int
                 $owner_id= 'null'

ID of the eZ Publish user who owns the application

Default valuenullDetails

Type: int

int
                 $updated= 'null'

Application update date, as a unix timestamp

Default valuenullDetails

Type: int

int
                 $version= 'null'

Application version, used to pre-create a draft when first creation a new application.

Default valuenullDetails

Type: int

Methods

__get(
          string $propertyName
          )
        
        :
          mixed

eZPersistentObject wrapper method: handles "function attributes"

Parameters

Name	Type	Description
$propertyName	string

Returns

Type	Description
mixed

__isset(
           $propertyName
          )
        
        :
          void

Parameters

Name	Type	Description
$propertyName

_owner(
          
          )
        
        :
          \eZUser

Returns the eZUser who owns the object

Returns

Type	Description
\eZUser

attribute(
          string $attributeName
          )
        
        :
          mixed

eZPersistentObject wrapper method

Parameters

Name	Type	Description
$attributeName	string

Returns

Type	Description
mixed

authorizeApplication(
           $clientId,  $endPointUri,  $clientSecret
              =
              null
          )
        
        :
          bool

static

Validates an authorization request by an application using the ID, redirection URI and secret if provided.

Parameters

Name	Type	Description
$clientId
$endPointUri
$clientSecret

Returns

Type	Description
bool	True if the app is valid, false if it isn't

Details

Todo: Enhance the return variable, as several status would be required. Exceptions, or constants ?
: string
: string
: string

authorizeFor(
          \eZUser $user
              =
              null
          )
        
        :
          void

Authorizes this application for a user

Parameters

Name	Type	Description
$user	\eZUser

fetchByClientId(
          string $clientId
          )
        
        :
          \ezpRestClient

static

Fetches a rest application using a client Id

Parameters

Name	Type	Description
$clientId	string

Returns

Type	Description
\ezpRestClient

getState(
          
          )
        
        :
          void

hasAttribute(
          string $attributeName
          )
        
        :
          bool

eZPersistentObject wrapper method

Parameters

Name	Type	Description
$attributeName	string

Returns

Type	Description
bool

isAuthorizedByUser(
          mixed $scope, \eZUser $user
              =
              null
          )
        
        :
          bool

Checks if this application has been authorized by the current user

Parameters

Name	Type	Description
$scope	mixed	The requested security scope
$user	\eZUser	The user to check authorization for. Will check for current user if not given.

Returns

Type	Description
bool

Details

Todo: Handle non-authorization using

isEndPointValid(
          string $endPointUri
          )
        
        :
          bool

Validates an attempt (endpoint) redirect URI against the one configured for the client

Parameters

Name	Type	Description
$endPointUri	string

Returns

Type	Description
bool	true if the URI is valid, false otherwise

setState(
           $properties
          )
        
        :
          void

Parameters

Name	Type	Description
$properties

validateSecret(
           $secret
          )
        
        :
          bool

Convenience method to validate a client secret.

Parameters

Name	Type	Description
$secret

Returns

Type	Description
bool