class SubscriptionListBuilder in Commerce Recurring Framework 8

List builder for subscriptions.

View source

class SubscriptionListBuilder extends EntityListBuilder {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    $instance = parent::createInstance($container, $entity_type);
    $instance->currentUser = $container
      ->get('current_user');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('ID');
    $header['title'] = $this
      ->t('Title');
    $header['type'] = $this
      ->t('Type');
    $header['billing_schedule'] = $this
      ->t('Billing schedule');
    $header['customer'] = $this
      ->t('Customer');
    $header['state'] = $this
      ->t('State');
    $header['start_date'] = $this
      ->t('Start date');
    $header['end_date'] = $this
      ->t('End date');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $entity */
    $row = [
      'id' => $entity
        ->id(),
      'title' => $entity
        ->getTitle(),
      'type' => $entity
        ->getType()
        ->getLabel(),
      'billing_schedule' => $entity
        ->getBillingSchedule()
        ->label(),
      'customer' => $entity
        ->getCustomer()
        ->getDisplayName(),
      'state' => $entity
        ->getState()
        ->getLabel(),
      'start_date' => $entity
        ->getStartDate()
        ->format('M jS Y H:i:s'),
      'end_date' => $entity
        ->getEndDate() ? $entity
        ->getEndDate()
        ->format('M jS Y H:i:s') : '-',
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritDoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);

    // For users with the 'update own commerce_subscription' permission, allow
    // the Edit operation only if the 'customer' form mode exists for the
    // subscription type. We do this so we never show the Edit operation using
    // the default form display (where all the fields are usually editable) to
    // customers.
    if (isset($operations['edit']) && $this->currentUser
      ->hasPermission('update own commerce_subscription') && !$this->currentUser
      ->hasPermission('update any commerce_subscription')) {
      $customer_form_mode_exists = \Drupal::entityQuery('entity_form_display')
        ->condition('id', "{$entity->getEntityTypeId()}.{$entity->bundle()}.customer")
        ->condition('status', TRUE)
        ->accessCheck(FALSE)
        ->range(0, 1)
        ->count()
        ->execute();
      if ($customer_form_mode_exists && $entity
        ->hasLinkTemplate('customer-edit-form')) {
        $operations['edit']['url'] = $this
          ->ensureDestination($entity
          ->toUrl('customer-edit-form'));
      }
      else {
        unset($operations['edit']);
      }
    }
    if ($entity
      ->access('cancel') && $entity
      ->hasLinkTemplate('cancel-form')) {
      $operations['cancel'] = [
        'title' => $this
          ->t('Cancel'),
        'weight' => 10,
        'url' => $this
          ->ensureDestination($entity
          ->toUrl('cancel-form')),
      ];
    }
    return $operations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
SubscriptionListBuilder::$currentUser	protected	property	The current user.
SubscriptionListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
SubscriptionListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
SubscriptionListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
SubscriptionListBuilder::getDefaultOperations	protected	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations

You are here

class SubscriptionListBuilder in Commerce Recurring Framework 8

Hierarchy

File

Namespace

Members

API Navigation