class BulkCloneProduct in Entity Bulk Clone 8

Entity Bulk clone of commerce product.

Plugin annotation

@Action(
  id = "bulk_clone_product_action",
  label = @Translation("Bulk Clone"),
  type = "commerce_product",
  confirm = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\entity_bulk_clone\Plugin\Action\BulkCloneProduct

File

src/Plugin/Action/BulkCloneProduct.php, line 18

Namespace

Drupal\entity_bulk_clone\Plugin\Action

class BulkCloneProduct extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $objects) {
    $results = [];
    foreach ($objects as $entity) {
      $results[] = $this
        ->execute($entity);
    }
    if (isset($results) && !empty($results)) {
      $batch = [
        'title' => $this
          ->t('Product Bulk Cloning...'),
        'operations' => $results,
        'finished' => '\\Drupal\\entity_bulk_clone\\Plugin\\BulkCloneProduct::batchFinished',
      ];
      batch_set($batch);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function batchFinished($success, $results, $operations) {

    // The 'success' parameter means no fatal PHP errors were detected.
    if ($success) {
      $message = \Drupal::translation()
        ->formatPlural(count($results), 'Bulk Clone was applied to ', '@count items.');
      \Drupal::messenger()
        ->addStatus($message);
    }
    else {
      $message = $this
        ->t('Finished with an error.');
      \Drupal::messenger()
        ->addError($message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {

    /** @var \Drupal\commerce_product\Entity\ProductInterface $entity */
    $replicator = \Drupal::service('replicate.replicator');
    $duplicate_entity = $replicator
      ->replicateByEntityId($entity
      ->getEntityTypeId(), $entity
      ->id());
    $title = $duplicate_entity
      ->getTitle();
    $duplicate_entity
      ->setTitle($title . ' - Bulk Cloned');
    $request_time = \Drupal::time()
      ->getRequestTime();
    $duplicate_entity
      ->setChangedTime($request_time);
    $duplicate_entity
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    /** @var \Drupal\commerce_product\Entity\ProductInterface $object */
    $result = $object
      ->access('update', $account, TRUE)
      ->andIf($object->status
      ->access('edit', $account, TRUE));
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BulkCloneProduct::access	public	function	Checks object access. Overrides ActionInterface::access
BulkCloneProduct::batchFinished	public static	function
BulkCloneProduct::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
BulkCloneProduct::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.