class BrightcovePlaylistDeleteQueueWorker in Brightcove Video Connect 3.x

Processes Entity Delete Tasks for Playlist.

Plugin annotation

@QueueWorker(
  id = "brightcove_playlist_delete_queue_worker",
  title = @Translation("Brightcove playlist delete queue worker."),
  cron = { "time" = 30 }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\brightcove\Plugin\QueueWorker\BrightcovePlaylistDeleteQueueWorker implements ContainerFactoryPluginInterface

File

src/Plugin/QueueWorker/BrightcovePlaylistDeleteQueueWorker.php, line 21

Namespace

Drupal\brightcove\Plugin\QueueWorker

class BrightcovePlaylistDeleteQueueWorker extends QueueWorkerBase implements ContainerFactoryPluginInterface {

  /**
   * The brightcove_playlist storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * Constructs a new BrightcovePlaylistDeleteQueueWorker object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   Brightcove Playlist Entity storage.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityStorageInterface $storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->storage = $storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager')
      ->getStorage('brightcove_playlist'));
  }

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {

    // Check the playlist if it is available on Brightcove or not.
    try {
      $cms = BrightcoveUtil::getCmsApi($data->api_client);
      $cms
        ->getPlaylist($data->playlist_id);
    } catch (APIException $e) {

      // If we got a not found response, delete the local version of the
      // playlist.
      if ($e
        ->getCode() == 404) {

        /** @var \Drupal\brightcove\Entity\BrightcovePlaylist $playlist */
        $playlist = $this->storage
          ->load($data->bcplid);
        $playlist
          ->delete(TRUE);
      }
      else {
        throw new APIException($e
          ->getMessage(), $e
          ->getCode(), $e, $e
          ->getResponseBody());
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BrightcovePlaylistDeleteQueueWorker::$storage	protected	property	The brightcove_playlist storage.
BrightcovePlaylistDeleteQueueWorker::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BrightcovePlaylistDeleteQueueWorker::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
BrightcovePlaylistDeleteQueueWorker::__construct	public	function	Constructs a new BrightcovePlaylistDeleteQueueWorker object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.