class clients_connection_drupal_services in Web Service Clients 7.3

Base class for Drupal client connections.

Hierarchy

• class \Entity implements EntityInterface
  • class \ClientsHandlerEntity
    • class \clients_connection_base
      • class \clients_connection_drupal_services

File

connections/clients_drupal/clients_drupal.inc, line 10

Contains classes for Client connections handlers.

class clients_connection_drupal_services extends clients_connection_base {

  // ============================================ Base: Constructor.

  /**
   * Constructor method.
   */
  function __construct(array $values = array(), $entityType = NULL) {

    // Call the base class to set the connection properties.
    parent::__construct($values, $entityType);

    // Decrypt the password.
    // TODO: move this to the loading of credentials.
    // Though nothing uses this any more!!!

    //$this->configuration['password'] = clients_drupal_decrypt($this->configuration['password']);
  }

  // ============================================ Base: Admin UI.

  /**
   * Declare an array of properties which should be treated as credentials.
   *
   * This lets the credentials storage plugin know which configuration
   * properties to take care of.
   *
   * @return
   *  A flat array of property names.
   */
  function credentialsProperties() {
    return array(
      'username',
      'password',
    );
  }

  /**
   * Submit handler for saving/updating connections of this class.
   *
   * @see clients_connection_form_submit()
   */
  function connectionSettingsForm_submit($form, &$form_state) {

    // This is here to show an example of how this method works.
    parent::connectionSettingsForm_submit($form, $form_state);
  }

  // ============================================ Base: Method calling.

  /**
   * Common helper for reacting to an error from an XMLRPC call.
   *
   * Gets the error from Drupal core's XMLRPC library, logs the error message,
   * and throws an exception, which should be caught by the module making use
   * of the Clients connection API.
   */
  function handleXmlrpcError() {

    // If the remote call resulted in an error, log it and throw an exception.
    $error = xmlrpc_error();
    if (is_object($error)) {
      watchdog('clients', 'Error calling method @method. Error was code @code with message "@message".', array(
        '@method' => $this->method,
        // Technically safe but who knows where this may come from, hence '@'.
        '@code' => $error->code,
        '@message' => $error->message,
      ));
      throw new Exception($error->message, $error->code);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
clients_connection_base::$cid	public	property	The connection id. Only set if this is stored in the database.
clients_connection_base::$configuration	public	property	An array of further configuration options.
clients_connection_base::$endpoint	public	property	The URL this connection connects to.
clients_connection_base::$name	public	property	The machine name of the connection.
clients_connection_base::callMethod		function	Call a remote method.
clients_connection_base::callMethodArray		function	Call a remote method with an array of parameters.	4
clients_connection_base::connectionSettingsFormAlter		function	Alter the connection settings form.	3
clients_connection_base::credentialsLoad		function	Load the credentials into the connection.
clients_connection_base::debug		function	Output debugging data.
clients_connection_base::formatEndpoint		function	Format the connection's endpoint as a link.	1
clients_connection_base::get_credentials_storage_plugin		function	Get the credentials storage plugin for this connection.
clients_connection_drupal_services::connectionSettingsForm_submit		function	Submit handler for saving/updating connections of this class. Overrides clients_connection_base::connectionSettingsForm_submit
clients_connection_drupal_services::credentialsProperties		function	Declare an array of properties which should be treated as credentials. Overrides clients_connection_base::credentialsProperties
clients_connection_drupal_services::handleXmlrpcError		function	Common helper for reacting to an error from an XMLRPC call.
clients_connection_drupal_services::__construct		function	Constructor method. Overrides ClientsHandlerEntity::__construct
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.