class SignupListBuilder in SendinBlue 8

Provides a list controller for content_entity_example_contact entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\sendinblue\Entity\Controller\SignupListBuilder

File

src/Entity/Controller/SignupListBuilder.php, line 20

Namespace

Drupal\sendinblue\Entity\Controller

class SignupListBuilder extends EntityListBuilder {

  /**
   * SendinblueManager.
   *
   * @var \Drupal\sendinblue\SendinblueManager
   */
  private $sendinblueManager;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   EntityTypeInterface.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   EntityStorageInterface.
   * @param \Drupal\sendinblue\SendinblueManager $sendinblueManager
   *   SendinblueManager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, SendinblueManager $sendinblueManager) {
    parent::__construct($entity_type, $storage);
    $this->sendinblueManager = $sendinblueManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('sendinblue.manager'));
  }

  /**
   * {@inheritdoc}
   *
   * We override ::render() so that we can add our own content above the table.
   * parent::render() is where EntityListBuilder creates the table using our
   * buildHeader() and buildRow() implementations.
   */
  public function render() {
    $build['table'] = parent::render();
    return $build;
  }

  /**
   * {@inheritdoc}
   *
   * Building the header and content lines for the contact list.
   *
   * Calling the parent::buildHeader() adds a column for the possible actions
   * and inserts the 'edit' and 'delete' links as defined for the entity type.
   */
  public function buildHeader() {
    $header['name'] = $this
      ->t('Name');
    $header['mode'] = $this
      ->t('Display Mode(s)');
    $header['mcLists'] = $this
      ->t('SendinBlue Lists');
    $header['access'] = $this
      ->t('Page Access');
    return $header + parent::buildHeader();
  }

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

    /* @var $entity \Drupal\sendinblue\Entity\Signup */
    $signup = $entity;
    $settings = $signup->settings
      ->first()
      ->getValue();
    $modes = NULL;
    $block_only = FALSE;
    switch ($signup->mode->value) {
      case SendinblueManager::SENDINBLUE_SIGNUP_BLOCK:
        $modes = Link::fromTextAndUrl($this
          ->t('Block'), Url::fromUri('internal:/admin/structure/block'))
          ->toString();
        $block_only = TRUE;
        break;
      case SendinblueManager::SENDINBLUE_SIGNUP_PAGE:
        $modes = Link::fromTextAndUrl($this
          ->t('Page'), Url::fromUri('internal:/' . $settings['path']))
          ->toString();
        break;
      case SendinblueManager::SENDINBLUE_SIGNUP_BOTH:
        $modes = Link::fromTextAndUrl($this
          ->t('Block'), Url::fromUri('internal:/admin/structure/block'))
          ->toString();
        $modes .= ' and ';
        $modes .= Link::fromTextAndUrl($this
          ->t('Page'), Url::fromUri('internal:/' . $settings['path']))
          ->toString();
        break;
    }
    $list_name = $this->sendinblueManager
      ->getListNameById($settings['subscription']['settings']['list']);
    $list_labels = Link::fromTextAndUrl($list_name, Url::fromUri(SendinblueManager::SIB_URL . '/users/list/id/?utm_source=drupal_plugin&utm_medium=plugin&utm_campaign=module_link' . $settings['subscription']['settings']['list']));
    if ($block_only) {
      $access = $this
        ->t('N/A - this form only exists as a block');
    }
    else {
      $all_roles_allowed = user_roles(FALSE, 'sendinblue_signup_all_forms' . $signup->name->value);
      $page_roles_allowed = user_roles(FALSE, 'sendinblue_signup_form_' . $signup->name->value);
      $roles_allowed = array_merge($all_roles_allowed, $page_roles_allowed);

      /** @var \Drupal\user\Entity\Role $role_object */
      foreach ($roles_allowed as $id => $role_object) {
        $roles_allowed[$id] = $role_object
          ->label();
      }
      $access = implode(', ', $roles_allowed);
    }
    $row['name'] = $signup->title->value;
    $row['mode'] = Markup::create($modes);
    $row['mcLists'] = $list_labels;
    $row['access'] = $access;
    return $row + parent::buildRow($entity);
  }

}

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::getDefaultOperations	protected	function	Gets this list's default operations.	2
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
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.
SignupListBuilder::$sendinblueManager	private	property	SendinblueManager.
SignupListBuilder::buildHeader	public	function	Building the header and content lines for the contact list. Overrides EntityListBuilder::buildHeader
SignupListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
SignupListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
SignupListBuilder::render	public	function	We override ::render() so that we can add our own content above the table. parent::render() is where EntityListBuilder creates the table using our buildHeader() and buildRow() implementations. Overrides EntityListBuilder::render
SignupListBuilder::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides EntityListBuilder::__construct
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.