class CampaignMonitorCampaignCampaignController in Campaign Monitor 8

Campaign Monitor Lists controller.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\campaignmonitor_campaign\Controller\CampaignMonitorCampaignCampaignController

Expanded class hierarchy of CampaignMonitorCampaignCampaignController

File

modules/campaignmonitor_campaign/src/Controller/CampaignMonitorCampaignCampaignController.php, line 17

Namespace

Drupal\campaignmonitor_campaign\Controller

View source

class CampaignMonitorCampaignCampaignController extends ControllerBase {

  /**
   * The entity handler.
   */
  protected $entityManager;

  /**
   * The current user account.
   */
  protected $account;

  /**
   * Constructs a NodeAccessControlHandler object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\node\NodeGrantDatabaseStorageInterface $grant_storage
   *   The node grant storage.
   */
  public function __construct(EntityManagerInterface $entity_manager) {
    $this->entityManager = $entity_manager;
    $this->account = \Drupal::currentUser();
  }

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

  /**
   * {@inheritdoc}
   */
  public function campaignsOverview() {
    $content = [];
    $campaigns_admin_url = Url::fromUri('https://waxeye.createsend.com/subscribers/', [
      'attributes' => [
        'target' => '_blank',
      ],
    ]);
    $campaigns_empty_message = t('You don\'t have any campaigns configured in your
      Campaign Monitor account, (or you haven\'t configured your API key correctly on
      the Global Settings tab). Head over to @link and create some campaigns, then
      come back here and click "Refresh campaigns from Campaign Monitor"', [
      '@link' => Link::fromTextAndUrl(t('Campaign Monitor'), $campaigns_admin_url)
        ->toString(),
    ]);
    $content['campaigns_table'] = [
      '#type' => 'table',
      '#header' => [
        t('Name'),
        t('Sent'),
        t('Link'),
      ],
      '#empty' => $campaigns_empty_message,
    ];
    $cm_campaigns = campaignmonitor_campaign_get_campaigns();
    foreach ($cm_campaigns as $key => $cm_campaign) {

      // $details = campaignmonitor_get_list_details($key);
      //      $stats = campaignmonitor_get_list_stats($key);
      $content['campaigns_table'][$key]['name'] = [
        '#markup' => $cm_campaign['Name'],
      ];
      $content['campaigns_table'][$key]['sent'] = [
        '#markup' => $cm_campaign['Sent'],
      ];
      $content['campaigns_table'][$key]['link'] = [
        '#markup' => $cm_campaign['Link'],
      ];
    }
    $refresh_url = Url::fromRoute('campaignmonitor.refresh_campaigns', [
      'destination' => 'admin/config/services/campaignmonitor/campaigns',
    ]);
    $content['refresh'] = [
      '#type' => 'container',
    ];
    $content['refresh']['refresh_link'] = [
      '#title' => 'Refresh campaigns from Campaign Monitor',
      '#type' => 'link',
      '#url' => $refresh_url,
    ];
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function draftsOverview() {
    $content = [];
    $drafts_admin_url = Url::fromUri('https://waxeye.createsend.com/subscribers/', [
      'attributes' => [
        'target' => '_blank',
      ],
    ]);
    $drafts_empty_message = t('You don\'t have any drafts configured in your
      Campaign Monitor account, (or you haven\'t configured your API key correctly on
      the Global Settings tab). Head over to @link and create some drafts, then
      come back here and click "Refresh drafts from Campaign Monitor"', [
      '@link' => Link::fromTextAndUrl(t('Campaign Monitor'), $drafts_admin_url)
        ->toString(),
    ]);
    $content['drafts_table'] = [
      '#type' => 'table',
      '#header' => [
        t('Name'),
        t('Author'),
        t('Created'),
        t('Link'),
      ],
      '#empty' => $drafts_empty_message,
    ];
    $cm_drafts = campaignmonitor_campaign_get_drafts();

    // $total_webhook_events = count(campaignmonitor_default_webhook_events());
    foreach ($cm_drafts as $key => $cm_campaign) {

      // $details = campaignmonitor_get_list_details($key);
      //      $stats = campaignmonitor_get_list_stats($key);
      $content['drafts_table'][$key]['name'] = [
        '#markup' => $cm_campaign['Name'],
      ];
      $content['drafts_table'][$key]['author'] = [
        '#markup' => $cm_campaign['From'],
      ];
      $content['drafts_table'][$key]['sent'] = [
        '#markup' => $cm_campaign['Created'],
      ];
      $content['drafts_table'][$key]['link'] = [
        '#type' => 'link',
        '#title' => 'Preview',
        '#url' => Url::fromUri($cm_campaign['Link']),
      ];
    }
    $refresh_url = Url::fromRoute('campaignmonitor.refresh_drafts', [
      'destination' => 'admin/config/services/campaignmonitor/drafts',
    ]);
    $content['refresh'] = [
      '#type' => 'container',
    ];
    $content['refresh']['refresh_link'] = [
      '#title' => 'Refresh drafts from Campaign Monitor',
      '#type' => 'link',
      '#url' => $refresh_url,
    ];
    return $content;
  }

  /**
   * Callback to clear config cache.
   */
  public function clearCampaignCache() {
    $caches = [
      'cache.config',
      'cache.data',
    ];
    campaignmonitor_clear_cache($caches);
    return new RedirectResponse('/admin/config/services/campaignmonitor/campaigns');
  }

  /**
   * Verify that a token is set for CSRF protection.
   */
  public function verifyAccess() {

    // If (!isset($_GET['token']) || !drupal_valid_token($_GET['token'])) {
    //      drupal_not_found();
    //      module_invoke_all('exit');
    //      exit();
    //    }
  }

  /**
   * Determine if menu item should exist
   * Drupal 8 does not appear to have provision for suppressing display of a menu item
   * So using access here as a substitute.
   *
   * @param $node_type
   *
   * @return \Drupal\Core\Access\AccessResult
   */
  public function nodeTypeAccess($node_type) {
    return AccessResult::allowedIf(campaignmonitor_campaign_type_is_configured($node_type));
  }

  /**
   * Campaign Monitor tab on Node page
   * Here the administrator can:
   *  - send the draft to Campaign monitor.
   *
   * @param $node
   *
   * @return array
   */
  public function NodeOverview($node) {
    $form = \Drupal::formBuilder()
      ->getForm('Drupal\\campaignmonitor_campaign\\Form\\CampaignMonitorCampaignSendForm', $node);

    // Also show the campaign in its selected View mode.
    $node_storage = $this->entityManager
      ->getStorage('node');

    // We use the load function to load a single node object.
    $node = $node_storage
      ->load($node);
    $view_builder = \Drupal::entityTypeManager()
      ->getViewBuilder('node');
    $settings = campaignmonitor_campaign_get_node_settings('all', $node
      ->bundle());
    $render_array = $view_builder
      ->view($node, $settings['view_mode']);
    $filepath = campaignmonitor_campaign_get_filepath($node, 'path');

    // $scan_css = new CampaignMonitorCssScanner($filepath);
    //
    return [
      'node' => $render_array,
      'form' => $form,
    ];
  }

  /**
   * Control access to the node tab for campaignmonitor.
   *
   * @param $node
   *
   * @return \Drupal\Core\Access\AccessResult
   */
  public function NodeTabAccess($node) {
    $node = Node::load($node);
    $bundle = $node
      ->bundle();
    return AccessResult::allowedIf(campaignmonitor_campaign_type_is_configured($bundle) && $this->account
      ->hasPermission("send {$bundle} campaigns"));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CampaignMonitorCampaignCampaignController::$account	protected	property	The current user account.
CampaignMonitorCampaignCampaignController::$entityManager	protected	property	The entity handler. Overrides ControllerBase::$entityManager
CampaignMonitorCampaignCampaignController::campaignsOverview	public	function
CampaignMonitorCampaignCampaignController::clearCampaignCache	public	function	Callback to clear config cache.
CampaignMonitorCampaignCampaignController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
CampaignMonitorCampaignCampaignController::draftsOverview	public	function
CampaignMonitorCampaignCampaignController::NodeOverview	public	function	Campaign Monitor tab on Node page Here the administrator can:
CampaignMonitorCampaignCampaignController::NodeTabAccess	public	function	Control access to the node tab for campaignmonitor.
CampaignMonitorCampaignCampaignController::nodeTypeAccess	public	function	Determine if menu item should exist Drupal 8 does not appear to have provision for suppressing display of a menu item So using access here as a substitute.
CampaignMonitorCampaignCampaignController::verifyAccess	public	function	Verify that a token is set for CSRF protection.
CampaignMonitorCampaignCampaignController::__construct	public	function	Constructs a NodeAccessControlHandler object.
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::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator 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.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class CampaignMonitorCampaignCampaignController in Campaign Monitor 8

Hierarchy

File

Namespace

Members

API Navigation