class RenewFile in Ubercart 8.4

Provides a 'Renew file grant' action.

Plugin annotation


@RulesAction(
  id = "uc_file_order_renew",
  label = @Translation("Renew the files on an order"),
  category = @Translation("Renewal"),
  context_definitions = {
    "order" = @ContextDefinition("entity:uc_order",
      label = @Translation("Order")
    )
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\rules\Core\RulesActionBase implements RulesActionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\uc_file\Plugin\RulesAction\RenewFile implements ContainerFactoryPluginInterface

Expanded class hierarchy of RenewFile

File

uc_file/src/Plugin/RulesAction/RenewFile.php, line 27

Namespace

Drupal\uc_file\Plugin\RulesAction

View source

class RenewFile extends RulesActionBase implements ContainerFactoryPluginInterface {

  /**
   * The database service.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The database service.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Constructs a RenewFile 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 mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Database\Connection $database
   *   The database service.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
   *   The event_dispatcher service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, EventDispatcherInterface $eventDispatcher) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->database = $database;
    $this->eventDispatcher = $eventDispatcher;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('database'), $container
      ->get('event_dispatcher'));
  }

  /**
   * Renews an order's product files.
   *
   * This function updates access limits on all files found on all products
   * on a given order. First the order user is loaded, then the order's products
   * are scanned for file product features. An order comment is saved, and the
   * user is notified in Drupal, as well as through the email address associated
   * with the order.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order object.
   */
  protected function doExecute(OrderInterface $order) {
    $user_downloads = [];

    // Load user.
    if (!($order_user = $order
      ->getOwner())) {
      return;
    }

    // Scan products for models matching downloads.
    foreach ($order->products as $product) {

      // SELECT * FROM {uc_file_products} fp
      // INNER JOIN {uc_product_features} pf ON pf.pfid = fp.pfid
      // INNER JOIN {uc_files} f ON f.fid = fp.fid
      // WHERE nid = $product->nid
      $query = $this->database
        ->select('uc_file_products', 'fp');
      $query
        ->join('uc_product_features', 'pf', 'pf.pfid = fp.pfid');
      $query
        ->join('uc_files', 'f', 'f.fid = fp.fid');
      $query
        ->condition('nid', $product->nid);
      $query
        ->fields('fp');
      $query
        ->fields('pf');
      $query
        ->fields('f');
      $files = $query
        ->execute();
      foreach ($files as $file) {

        // Either they match, or the file was set to any SKU.
        if (!empty($file->model) && $file->model != $product->model) {
          continue;
        }

        // Grab any existing privilege so we can calculate the new expiration
        // time as an offset of the previous.
        $file_user = _uc_file_user_get($order_user, $file->fid);

        // Get the limit info from the product feature.
        $file_modification = [
          'download_limit' => uc_file_get_download_limit($file),
          'address_limit' => uc_file_get_address_limit($file),
          'expiration' => _uc_file_expiration_date(uc_file_get_time_limit($file), $file_user ? max($file_user->expiration, REQUEST_TIME) : NULL),
        ];

        // Add file_user(s) for this file/directory. (No overwrite).
        $new_files = uc_file_user_renew($file->fid, $order_user, $file->pfid, $file_modification, FALSE);

        // Save for notification.
        $user_downloads = array_merge($user_downloads, $new_files);

        // Note on the order where the user has gained download permission.
        if (is_dir(uc_file_qualify_file($file->filename))) {
          $comment = $this
            ->t('User can now download files in the directory %dir.', [
            '%dir' => $file->filename,
          ]);
        }
        else {
          $comment = $this
            ->t('User can now download the file %file.', [
            '%file' => \Drupal::service('file_system')
              ->basename($file->filename),
          ]);
        }
        uc_order_comment_save($order
          ->id(), $order_user
          ->id(), $comment);
      }
    }

    // Notify the user of their download(s).
    if ($user_downloads) {

      /* rules_invoke_event('uc_file_notify_grant', $order, $user_downloads); */
      $event = new NotifyGrantEvent($order, $user_downloads);
      $this->eventDispatcher
        ->dispatch($event::EVENT_NAME, $event);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
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		1
DependencySerializationTrait::__wakeup	public	function		2
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
ExecutablePluginTrait::summary	public	function	Get the translated summary from the label annotation.	4
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	3
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.
RenewFile::$database	protected	property	The database service.
RenewFile::$eventDispatcher	protected	property	The database service.
RenewFile::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RenewFile::doExecute	protected	function	Renews an order's product files.
RenewFile::__construct	public	function	Constructs a RenewFile object. Overrides ContextAwarePluginBase::__construct
RulesActionBase::$configuration	protected	property	The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access	public	function	Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext	public	function	Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext	14
RulesActionBase::calculateDependencies	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::defaultConfiguration	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	2
RulesActionBase::executeMultiple	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::getConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesActionBase::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions	5
RulesActionBase::setConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class RenewFile in Ubercart 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation