You are here

mail_safety.entity.inc in Mail Safety 7.2

Entity functionality for Mail Safety

File

mail_safety.entity.inc
View source
<?php

/**
 * @file
 * Entity functionality for Mail Safety
 */

/**
 * Implements hook_entity_info().
 */
function mail_safety_entity_info() {
  $info['mail_safety_mail'] = array(
    'label' => t('Mail Safety mail'),
    'plural label' => t('Mail Safety mails'),
    'entity class' => 'EntityClass',
    'views controller class' => 'EntityDefaultViewsController',
    'controller class' => 'EntityAPIController',
    'base table' => 'mail_safety_mail',
    'uri callback' => 'mail_safety_mail_basic_uri',
    'fieldable' => FALSE,
    'entity keys' => array(
      'id' => 'mid',
    ),
  );
  return $info;
}

/**
 * Implements the uri callback.
 */
function mail_safety_mail_basic_uri($mail_safety_mail) {
  return array(
    'path' => 'mail_safety/mail/' . $mail_safety_mail->mail_id,
  );
}

/**
 * Load a mail safety mail entity.
 *
 * @param int $mid
 * @param bool $reset
 * @return bool|mixed
 */
function mail_safety_mail_load($mid = NULL, $reset = FALSE) {
  $mids = isset($mid) ? array(
    $mid,
  ) : array();
  $mails = mail_safety_mail_load_multiple($mids, array(), $reset);
  return $mails ? reset($mails) : FALSE;
}

/**
 * Save the mail safety mail.
 *
 * @param $mail_safety_mail
 * @return mixed
 */
function mail_safety_mail_save($mail_safety_mail) {
  return entity_get_controller('mail_safety_mail')
    ->save($mail_safety_mail);
}

/**
 * Use the controller to delete the entity.
 */
function mail_safety_mail_delete($entity) {
  entity_get_controller('mail_safety_mail')
    ->delete($entity);
}

/**
 * Load multiple mail safety mails at once.
 *
 * @param array $mids
 * @param array $conditions
 * @param bool $reset
 *
 * @return mixed
 */
function mail_safety_mail_load_multiple($mids = array(), $conditions = array(), $reset = FALSE) {
  $entities = entity_load('mail_safety_mail', $mids, $conditions, $reset);
  foreach ($entities as &$entity) {
    if (!empty($entity->mail_serialized)) {
      $entity->message = unserialize($entity->mail_serialized);
    }
  }
  return $entities;
}

Functions

Namesort descending Description
mail_safety_entity_info Implements hook_entity_info().
mail_safety_mail_basic_uri Implements the uri callback.
mail_safety_mail_delete Use the controller to delete the entity.
mail_safety_mail_load Load a mail safety mail entity.
mail_safety_mail_load_multiple Load multiple mail safety mails at once.
mail_safety_mail_save Save the mail safety mail.