class MailChimpCampaignController in Mailchimp 7.4

@file MailChimpCampaign controller class.

Hierarchy

• class \DrupalDefaultEntityController implements DrupalEntityControllerInterface
  • class \EntityAPIController implements EntityAPIControllerRevisionableInterface
    • class \MailChimpCampaignController

1 string reference to 'MailChimpCampaignController'

mailchimp_campaign_entity_info in modules/mailchimp_campaign/mailchimp_campaign.module

Implements hook_entity_info().

File

modules/mailchimp_campaign/includes/mailchimp_campaign.controller.inc, line 8

MailChimpCampaign controller class.

class MailChimpCampaignController extends EntityAPIController {

  /**
   * Implement in order to attach Mailchimp data to campaign entities.
   */
  protected function attachLoad(&$campaigns, $revision_id = FALSE) {
    $ids = array();
    if (!empty($campaigns)) {
      foreach ($campaigns as $campaign) {
        $ids[] = $campaign->mc_campaign_id;
      }
    }
    $mc_campaigns = mailchimp_campaign_get_campaigns($ids);
    foreach ($campaigns as $mc_campaign_id => $campaign) {
      $campaign->mc_data = $mc_campaigns[$mc_campaign_id];

      // Lists are cached separately, but we want to load them here.
      if (isset($campaign->mc_data->recipients->list_id) && $campaign->mc_data->recipients->list_id) {
        $campaign->list = mailchimp_get_list($campaign->mc_data->recipients->list_id);
      }
      if (!empty($campaign->mc_data->settings->template_id)) {
        $campaign->mc_template = mailchimp_campaign_get_template($campaign->mc_data->settings->template_id);
      }
    }
    parent::attachLoad($campaigns, $revision_id);
  }

  /**
   * Implement to clear Mailchimp campaign data caches.
   *
   * @param array $ids
   *   Optional array of campaign IDs to clear cache for.
   */
  public function resetCache(array $ids = NULL) {
    parent::resetCache($ids);
    if ($cached_campaigns = cache_get('campaigns', 'cache_mailchimp')) {

      // Reset granular campaigns.
      if (isset($ids)) {
        foreach ($cached_campaigns->data as $id => $cached_campaign) {
          if (in_array($id, $ids)) {
            unset($cached_campaigns->data[$id]);
          }
        }
      }
      $cache_data = isset($cached_campaigns) ? $cached_campaigns->data : NULL;
      cache_set('campaigns', $cache_data, 'cache_mailchimp');
    }
  }

  /**
   * Overrides EntityAPIController::buildQuery().
   *
   * Implement to order by created date since our IDs are not numeric.
   */
  protected function buildQuery($ids, $conditions = array(), $revision_id = FALSE) {
    $query = parent::buildQuery($ids, $conditions, $revision_id);
    $query
      ->orderBy('created', 'DESC');
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DrupalDefaultEntityController::$cache	protected	property	Whether this entity type should use the static cache.
DrupalDefaultEntityController::$entityCache	protected	property	Static cache of entities, keyed by entity ID.
DrupalDefaultEntityController::$entityInfo	protected	property	Array of information about the entity.
DrupalDefaultEntityController::$entityType	protected	property	Entity type for this controller instance.
DrupalDefaultEntityController::$hookLoadArguments	protected	property	Additional arguments to pass to hook_TYPE_load().
DrupalDefaultEntityController::$idKey	protected	property	Name of the entity's ID field in the entity database table.
DrupalDefaultEntityController::$revisionKey	protected	property	Name of entity's revision database table field, if it supports revisions.
DrupalDefaultEntityController::$revisionTable	protected	property	The table that stores revisions, if the entity supports revisions.
DrupalDefaultEntityController::cacheGet	protected	function	Gets entities from the static cache.	1
DrupalDefaultEntityController::cacheSet	protected	function	Stores entities in the static entity cache.
DrupalDefaultEntityController::cleanIds	protected	function	Ensures integer entity IDs are valid.
DrupalDefaultEntityController::filterId	protected	function	Callback for array_filter that removes non-integer IDs.
EntityAPIController::$bundleKey	protected	property
EntityAPIController::$cacheComplete	protected	property
EntityAPIController::$defaultRevisionKey	protected	property
EntityAPIController::buildContent	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::buildContent
EntityAPIController::create	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::create
EntityAPIController::delete	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::delete	1
EntityAPIController::deleteRevision	public	function	Implements EntityAPIControllerRevisionableInterface::deleteRevision(). Overrides EntityAPIControllerRevisionableInterface::deleteRevision
EntityAPIController::export	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::export	1
EntityAPIController::import	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::import
EntityAPIController::invoke	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::invoke	1
EntityAPIController::load	public	function	Overridden. Overrides DrupalDefaultEntityController::load	1
EntityAPIController::query	public	function	Builds and executes the query for loading.
EntityAPIController::renderEntityProperty	protected	function	Renders a single entity property.
EntityAPIController::save	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::save	1
EntityAPIController::saveRevision	protected	function	Saves an entity revision.
EntityAPIController::view	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::view	1
EntityAPIController::__construct	public	function	Overridden. Overrides DrupalDefaultEntityController::__construct	1
MailChimpCampaignController::attachLoad	protected	function	Implement in order to attach Mailchimp data to campaign entities. Overrides DrupalDefaultEntityController::attachLoad
MailChimpCampaignController::buildQuery	protected	function	Overrides EntityAPIController::buildQuery(). Overrides EntityAPIController::buildQuery
MailChimpCampaignController::resetCache	public	function	Implement to clear Mailchimp campaign data caches. Overrides EntityAPIController::resetCache