class Lockr in Lockr 7.2

Primary interface for Lockr API calls.

Hierarchy

• class \Lockr\Lockr

1 file declares its use of Lockr

lockr.module in ./lockr.module

Hook implementations and callbacks for lockr.

3 string references to 'Lockr'

lockr.inc in plugins/key_provider/lockr.inc

Key provider plugin for lockr.

lockr_login_form in ./lockr.login.inc

Register a Lockr user with already established credentials.

lockr_menu in ./lockr.module

Implements hook_menu().

File

vendor/lockr/lockr-client/src/Lockr.php, line 13

Namespace

Lockr

class Lockr {

  /**
   * @const The current client version.
   */
  const VERSION = '0.1.0';

  /**
   * @var The partner instance.
   */
  protected static $instance = null;

  /**
   * @var The partner client.
   */
  protected $partner;

  /**
   * Constructs Lockr with a partner.
   *
   * @param PartnerInterface $partner The partner client.
   */
  public function __construct(PartnerInterface $partner) {
    $this->partner = $partner;
  }

  /**
   * Returns the client for site operations.
   *
   * @return SiteClient The site client.
   */
  public static function site() {
    return new SiteClient(self::create());
  }

  /**
   * Returns the client for key operations.
   *
   * @return KeyClient The key client.
   */
  public static function key() {
    return new KeyClient(self::create());
  }

  /**
   * Get the partner instance.
   *
   * @return static The partner instance.
   */
  public static function create(PartnerInterface $partner = null) {
    if (null == static::$instance) {
      if ($partner !== null) {
        static::$instance = new static($partner);
      }
      else {
        static::$instance = new static(new Partner());
      }
    }
    return static::$instance;
  }
  public function get($uri) {
    $uri = $this->partner
      ->getReadUri() . $uri;
    return $this
      ->request('GET', $uri, $this->partner
      ->requestOptions());
  }
  public function head($uri) {
    $uri = $this->partner
      ->getReadUri() . $uri;
    return $this
      ->request('HEAD', $uri, $this->partner
      ->requestOptions());
  }
  public function post($uri, $data, $auth = null) {

    // horrible hack needed until Lockr v2
    $uri = $this->partner
      ->getAccountingUri() . $uri;
    $options = $this->partner
      ->requestOptions();
    $options['data'] = $data;
    if (null !== $auth) {
      $options['auth'] = $auth;
    }
    return $this
      ->request('POST', $uri, $options);
  }
  public function patch($uri, $data) {
    $uri = $this->partner
      ->getWriteUri() . $uri;
    $options = $this->partner
      ->requestOptions();
    $options['data'] = $data;
    return $this
      ->request('PATCH', $uri, $options);
  }
  public function delete($uri) {
    $uri = $this->partner
      ->getWriteUri() . $uri;
    return $this
      ->request('DELETE', $uri, $this->partner
      ->requestOptions());
  }
  protected function request($method, $uri, array $options = array()) {
    $opts = array(
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_PORT => 443,
      CURLOPT_CUSTOMREQUEST => $method,
      CURLOPT_URL => $uri,
      CURLOPT_HTTPHEADER => array(
        'Content-Type:',
      ),
    );
    if (in_array($method, array(
      'POST',
      'PATCH',
    ))) {
      $data = json_encode($options['data']);
      $opts[CURLOPT_POSTFIELDS] = $data;
      $opts[CURLOPT_HTTPHEADER] = array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen($data),
      );
    }
    if (isset($options['cert'])) {
      $opts[CURLOPT_SSLCERT] = $options['cert'];
    }
    if (isset($options['auth'])) {
      $opts[CURLOPT_USERPWD] = $options['auth'];
    }
    $ch = curl_init();
    curl_setopt_array($ch, $opts);
    $resp = curl_exec($ch);
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    $body = json_decode($resp, true);
    $json_error = json_last_error();
    if ($code >= 400) {
      if ($json_error !== JSON_ERROR_NONE) {
        $body = array(
          'title' => 'Unrecognized body',
          'description' => $resp,
        );
      }
      $this
        ->handleError($code, $body);
    }
    if (!$resp) {
      return true;
    }
    if ($json_error !== JSON_ERROR_NONE) {
      throw new LockrException(array(
        'message' => $resp,
        'code' => $code,
      ));
    }
    return $body;
  }

  /**
   * Parses an error response and throws the correct exception.
   */
  public function handleError($code, $body) {
    $title = isset($body['title']) ? $body['title'] : '';
    $description = isset($body['description']) ? $body['description'] : '';
    $params = array(
      'title' => $title,
      'description' => $description,
      'message' => "[{$title}]: {$description}",
      'code' => $code,
    );
    if ($code >= 500) {
      throw new LockrServerException($params);
    }
    throw new LockrClientException($params);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Lockr::$instance	protected static	property
Lockr::$partner	protected	property
Lockr::create	public static	function	Get the partner instance.
Lockr::delete	public	function
Lockr::get	public	function
Lockr::handleError	public	function	Parses an error response and throws the correct exception.
Lockr::head	public	function
Lockr::key	public static	function	Returns the client for key operations.
Lockr::patch	public	function
Lockr::post	public	function
Lockr::request	protected	function
Lockr::site	public static	function	Returns the client for site operations.
Lockr::VERSION		constant	@const The current client version.
Lockr::__construct	public	function	Constructs Lockr with a partner.