class MailchimpFieldsController in Mailchimp 2.x

Mailchimp Fields controller.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\mailchimp_lists\Controller\MailchimpFieldsController

File

modules/mailchimp_lists/src/Controller/MailchimpFieldsController.php, line 14

Namespace

Drupal\mailchimp_lists\Controller

class MailchimpFieldsController extends ControllerBase {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Initializes a MailchimpCampaignController.
   *
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager..
   */
  public function __construct(EntityFieldManagerInterface $entity_field_manager) {
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function overview() {
    $content = [];
    $content['description'] = [
      '#markup' => $this
        ->t('This displays a list of all Mailchimp Subscription Fields
        configured on your system, with a row for each unique Instance of that field.
        To edit each field\'s settings, go to the Entity Bundle\'s configuration
        screen and use the Field UI.
        When entities with Mailchimp Subscription Fields are updated,
        the Merge Variables configured through Field UI are automatically updated if necessary.
        However, if you have existing subscribers on Mailchimp and matching Entities
        on Drupal when you configure your Merge Variables, the existing values
        are not synced automatically, as this could be a slow process.
        You can manually force updates of all existing Merge Values to existing
        Mailchimp subscribers for each field configuration using the \'Batch Update\'
        option on this table. The Mailchimp Subscription Field is provided by the
        Mailchimp Audiences (mailchimp_lists) module.'),
    ];
    $content['fields_table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Entity Type'),
        $this
          ->t('Bundle'),
        $this
          ->t('Field'),
        $this
          ->t('Batch Update'),
      ],
      '#empty' => '',
    ];
    $field_map = $this->entityFieldManager
      ->getFieldMap();
    $row_id = 1;
    foreach ($field_map as $entity_type => $fields) {
      foreach ($fields as $field_name => $field_properties) {
        if ($field_properties['type'] == 'mailchimp_lists_subscription') {
          foreach ($field_properties['bundles'] as $bundle) {
            $batch_update_url = Url::fromRoute('mailchimp_lists.update_mergevars', [
              'entity_type' => $entity_type,
              'bundle' => $bundle,
              'field_name' => $field_name,
              'destination' => 'admin/config/services/mailchimp/fields',
            ]);
            $content['fields_table'][$row_id]['entity_type'] = [
              '#markup' => $entity_type,
            ];
            $content['fields_table'][$row_id]['bundle'] = [
              '#markup' => $bundle,
            ];
            $content['fields_table'][$row_id]['field'] = [
              '#markup' => $field_name,
            ];
            $content['fields_table'][$row_id]['batch_update'] = [
              '#markup' => Link::fromTextAndUrl($this
                ->t('Update Mailchimp Mergevar Values'), $batch_update_url)
                ->toString(),
            ];
            $row_id++;
          }
        }
      }
    }
    return $content;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MailchimpFieldsController::$entityFieldManager	protected	property	The entity field manager.
MailchimpFieldsController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
MailchimpFieldsController::overview	public	function
MailchimpFieldsController::__construct	public	function	Initializes a MailchimpCampaignController.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.