You are here

class NewsletterListController in Newsletter 7.2

Same name and namespace in other branches
  1. 7 includes/newsletter.list.controller.inc \NewsletterListController

Newsletter List Controller

Hierarchy

Expanded class hierarchy of NewsletterListController

1 string reference to 'NewsletterListController'
newsletter_list_entity_info in modules/list/newsletter_list.module
Implements hook_entity_info().

File

modules/list/includes/newsletter_list.controller.inc, line 11
Controller class definition file for newsletter_list entity.

View source
class NewsletterListController extends DrupalDefaultEntityController {

  /**
   * Create a default list.
   *
   * @param array $values
   *   An array of values to set, keyed by property name.
   * @return
   *   A list object with all default fields initialized.
   */
  public function create() {
    $values += array(
      'list_id' => '',
      'is_new' => TRUE,
      'title' => NULL,
      'send_rate' => NULL,
      'template_id' => NULL,
    );
    return parent::create($values);
  }

  /**
   * Saves a new newsletter list in database.
   *
   * @param $list
   *   The full list object to save.
   * @param $transaction
   *   An optional transaction object.
   *
   * @return
   *   SAVED_NEW or SAVED_UPDATED depending on the operation performed..
   */
  public function save($list, DatabaseTransaction $transaction = NULL) {
    if ($list->is_new) {
      $list->created = REQUEST_TIME;
    }
    return parent::save($list);
  }

}

Members

Namesort descending 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::attachLoad protected function Attaches data to entities upon loading. 4
DrupalDefaultEntityController::buildQuery protected function Builds the query to load the entity. 4
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.
DrupalDefaultEntityController::load public function Implements DrupalEntityControllerInterface::load(). Overrides DrupalEntityControllerInterface::load
DrupalDefaultEntityController::resetCache public function Implements DrupalEntityControllerInterface::resetCache(). Overrides DrupalEntityControllerInterface::resetCache
DrupalDefaultEntityController::__construct public function Constructor: sets basic variables.
NewsletterListController::create public function Create a default list.
NewsletterListController::save public function Saves a new newsletter list in database.