class WSCall in Web Service Data 8

Same name and namespace in other branches

2.0.x src/Entity/WSCall.php \Drupal\wsdata\Entity\WSCall

Defines the Web Service Call entity.

Plugin annotation


@ConfigEntityType(
  id = "wscall",
  label = @Translation("Web Service Call"),
  handlers = {
    "list_builder" = "Drupal\wsdata\WSCallListBuilder",
    "view_builder" = "Drupal\wsdata\WSCallViewBuilder",
    "form" = {
      "add" = "Drupal\wsdata\Form\WSCallForm",
      "edit" = "Drupal\wsdata\Form\WSCallForm",
      "delete" = "Drupal\wsdata\Form\WSCallDeleteForm",
      "test" = "Drupal\wsdata\Form\WSCallTestForm"
    },
    "route_provider" = {
      "html" = "Drupal\wsdata\WSCallHtmlRouteProvider",
    },
  },
  config_prefix = "wscall",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  links = {
    "canonical" = "/admin/structure/wscall/{wscall}",
    "add-form" = "/admin/structure/wscall/add",
    "edit-form" = "/admin/structure/wscall/{wscall}/edit",
    "delete-form" = "/admin/structure/wscall/{wscall}/delete",
    "collection" = "/admin/structure/wscall"
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\wsdata\Entity\WSCall implements WSCallInterface uses StringTranslationTrait

Expanded class hierarchy of WSCall

1 string reference to 'WSCall'

WSCallTestForm::form in src/Form/WSCallTestForm.php: Gets the actual form array to be built.

File

src/Entity/WSCall.php, line 44

Namespace

Drupal\wsdata\Entity

View source

class WSCall extends ConfigEntityBase implements WSCallInterface {
  use StringTranslationTrait;

  /**
   * The Web Service Call ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The Web Service Call label.
   *
   * @var string
   */
  protected $label;
  public $options;
  public $wsserver;
  public $wsdecoder;
  public $wsencoder;
  protected $wsserverInst;
  protected $wsdecoderInst;
  protected $wsencoderInst;
  protected $status;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values, $entity_type) {
    parent::__construct($values, $entity_type);
    if ($this->wsserver) {
      $this->wsserverInst = \Drupal::service('entity_type.manager')
        ->getStorage('wsserver')
        ->load($this->wsserver);
    }
    if ($this->wsdecoder) {

      // Set the decoder instance.
      $wsdecoderManager = \Drupal::service('plugin.manager.wsdecoder');
      $this->wsdecoderInst = $wsdecoderManager
        ->createInstance($this->wsdecoder);
    }
    if ($this->wsencoder) {

      // Set the enocder instance.
      $wsencoderManager = \Drupal::service('plugin.manager.wsencoder');
      $this->wsencoderInst = $wsencoderManager
        ->createInstance($this->wsencoder);
    }
    $this->status = [];
  }

  /**
   * {@inheritdoc}
   */
  public function setEndpoint($endpoint) {
    if ($this->wsserverInst) {
      $this->wsserverInst
        ->setEndpoint($endpoint);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getEndpoint() {
    return $this->wsserverInst ? $this->wsserverInst
      ->getEndpoint() : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function call($method = NULL, $replacements = [], $data = NULL, $options = [], $key = NULL, $tokens = [], $cache_tag = [], &$context = []) {
    $this->status = [
      'method' => $method,
      'status' => 'called',
    ];
    if (!$this->wsserverInst) {
      $this->status['status'] = 'error';
      $this->status['error_message'] = $this
        ->t('No WSServer Instance to found.');
      $this->status['error'] = TRUE;
      return FALSE;
    }

    // Build out the Cache ID based on the parameters passed.
    $conn = $this
      ->getConnector();
    $cid_array = array_merge($this
      ->getOptions(), $options, $replacements, $tokens, [
      'data' => $data,
      'key' => $key,
      'conn' => $conn
        ->getCache(),
    ]);
    $cid = md5(serialize($cid_array));
    $this->status['cache']['cid'] = $cid;
    $this->status['cache']['cached'] = FALSE;
    $this->status['called'] = FALSE;

    // Try to retrieve the data from cache.
    if ($cache = \Drupal::cache('wsdata')
      ->get($cid)) {
      $this->status['status'] = 'success';
      $this->status['cache']['cached'] = FALSE;
      $cache_data = $cache->data;
      if ($this->wsdecoderInst
        ->isCacheable()) {
        $this->status['cache']['debug'] = $this
          ->t('Returning parsed data from cache');
        return $cache_data;
      }
      $this->status['cache']['debug'] = $this
        ->t('Loaded WSCall result from cache and re-parsed the data');
      $this
        ->addData($cache_data);
      return $this
        ->getData($key);
    }

    // Try to make the call.
    $options = array_merge($this
      ->getOptions(), $options);
    if ($method and !in_array($method, $conn
      ->getMethods())) {
      throw new WSDataInvalidMethodException(sprintf('Invalid method %s on connector type %s', $method, $this->wsserverInst->wsconnector));
    }
    elseif (isset($options['method']) and in_array($options['method'], $conn
      ->getMethods())) {
      $method = $options['method'];
    }
    else {
      $methods = $conn
        ->getMethods();
      $method = reset($methods);
    }
    $context = [
      'replacements' => $replacements,
      'data' => $data,
      'options' => &$options,
      'key' => $key,
      'tokens' => $tokens,
    ];

    // Encode the payload data.
    $this->wsencoderInst
      ->encode($data, $replacements, $options['path'], $context);

    // Call the connector.
    $result = $conn
      ->call($options, $method, $replacements, $data, $tokens);
    $this->status['call-status'] = $conn
      ->getStatus();

    // Handle error case.
    if (!empty($conn
      ->getError())) {
      $this->status['error'] = TRUE;
      $message = $this
        ->t('wsdata %wsdata_name failed with error %code %message', [
        '%wsdata_name' => $this->id,
        '%code' => $conn
          ->getError()['code'],
        '%message' => $conn
          ->getError()['message'],
      ]);
      $this->status['error_message'] = $message;
      \Drupal::logger('wsdata')
        ->error($message);
      return FALSE;
    }
    $this
      ->addData($result, $context);
    $data = $this
      ->getData($key);
    $result_expires = (int) $conn
      ->expires();
    $this->status['called'] = TRUE;
    $this->status['cache']['wsencoder'] = $this->wsencoderInst
      ->isCacheable();
    $this->status['cache']['wsdecoder'] = $this->wsdecoderInst
      ->isCacheable();
    $this->status['cache']['wsconnect'] = $conn
      ->supportsCaching($method);
    $this->status['cache']['expires'] = $result_expires;
    $expires = time() + $result_expires;

    // Fetch the cache tags for this call and the server instance call.
    $cache_tags = array_merge($this->wsserverInst
      ->getCacheTags(), $this
      ->getCacheTags(), $cache_tag);
    $this->status['cache']['tags'] = $cache_tags;
    if ($conn
      ->supportsCaching($method) && $this->wsencoderInst
      ->isCacheable()) {
      if ($this->wsdecoderInst
        ->isCacheable()) {
        $this->status['cache']['debug'] = $this
          ->t('Caching the parsed results of the WSCall for %ex seconds', [
          '%ex' => $result_expires,
        ]);
        \Drupal::cache('wsdata')
          ->set($cid, $data, $expires, $cache_tags);
      }
      else {
        $this->status['cache']['debug'] = $this
          ->t('Caching the verbatim result of the WSCall for %ex seconds.', [
          '%ex' => $result_expires,
        ]);
        \Drupal::cache('wsdata')
          ->set($cid, $result, $expires, $cache_tags);
      }
    }
    else {
      $this->status['cache']['debug'] = $this
        ->t('Result is not cachable');
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   *
   * Doesn't save the WSCall though.
   */
  public function setOptions($values = []) {
    if (!isset($this->wsserverInst)) {
      $this->wsserverInst = \Drupal::service('entity_type.manager')
        ->getStorage('wsserver')
        ->load($values['wsserver']);
    }
    $this->options[$this->wsserver] = $this->wsserverInst->wsconnectorInst
      ->saveOptions($values);
    $this->needSave = TRUE;
  }

  /**
   * Returns the status of the last call.
   */
  public function lastCallStatus() {
    return $this->status;
  }

  /**
   * {@inheritdoc}
   */
  public function getReplacements() {
    return $this->wsserverInst ? $this->wsserverInst->wsconnectorInst
      ->getReplacements($this
      ->getOptions()) : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptionsForm($wsserver = NULL, $options = []) {
    if (isset($wsserver)) {
      $wsserverInst = \Drupal::service('entity_type.manager')
        ->getStorage('wsserver')
        ->load($wsserver);
      return $wsserverInst->wsconnectorInst
        ->getOptionsForm($options);
    }
    if (isset($this->wsserverInst->wsconnectorInst)) {
      return $this->wsserverInst->wsconnectorInst
        ->getOptionsForm($options);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return isset($this->options[$this->wsserver]) ? $this->options[$this->wsserver] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function getMethods() {
    return $this->wsserverInst ? $this->wsserverInst
      ->getMethods() : [];
  }

  /**
   * {@inheritdoc}
   */
  public function addData($data, $context = []) {
    if (!isset($this->wsdecoderInst)) {
      $wsdecoderManager = \Drupal::service('plugin.manager.wsdecoder');
      $this->wsdecoderInst = $wsdecoderManager
        ->createInstance($this->wsdecoder);
    }
    return $this->wsdecoderInst
      ->addData($data, NULL, $context);
  }

  /**
   * {@inheritdoc}
   */
  public function getData($key = NULL) {
    if (isset($this->wsdecoderInst)) {
      return $this->wsdecoderInst
        ->getData($key);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getConnector() {
    return $this->wsserverInst ? $this->wsserverInst
      ->getConnector() : FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function
WSCall::$id	protected	property	The Web Service Call ID.
WSCall::$label	protected	property	The Web Service Call label.
WSCall::$options	public	property
WSCall::$status	protected	property	The enabled/disabled status of the configuration entity. Overrides ConfigEntityBase::$status
WSCall::$wsdecoder	public	property
WSCall::$wsdecoderInst	protected	property
WSCall::$wsencoder	public	property
WSCall::$wsencoderInst	protected	property
WSCall::$wsserver	public	property
WSCall::$wsserverInst	protected	property
WSCall::addData	public	function
WSCall::call	public	function	Make the web service call. Overrides WSCallInterface::call
WSCall::getConnector	public	function
WSCall::getData	public	function
WSCall::getEndpoint	public	function	Return the endpoint from the active wsserver. Overrides WSCallInterface::getEndpoint
WSCall::getMethods	public	function	Get the available methods. Overrides WSCallInterface::getMethods
WSCall::getOptions	public	function	Return the active options. Overrides WSCallInterface::getOptions
WSCall::getOptionsForm	public	function	Get the forms provided by the wsserver for the wscall. Overrides WSCallInterface::getOptionsForm
WSCall::getReplacements	public	function	Get the available replacement tokens. Overrides WSCallInterface::getReplacements
WSCall::lastCallStatus	public	function	Returns the status of the last call. Overrides WSCallInterface::lastCallStatus
WSCall::setEndpoint	public	function	Override the endpoint in the active wsserver. Overrides WSCallInterface::setEndpoint
WSCall::setOptions	public	function	Doesn't save the WSCall though. Overrides WSCallInterface::setOptions
WSCall::__construct	public	function	Constructs an Entity object. Overrides ConfigEntityBase::__construct

You are here

class WSCall in Web Service Data 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation