pet.api.php in Previewable email templates 8.3

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

@todo: update file.

File

pet.api.php

<?php

/**
 * @file
 * This file contains no working PHP code; it exists to provide additional
 * documentation for doxygen as well as to document hooks in the standard
 * Drupal manner.
 *
 * @todo: update file.
 */

/**
 * @defgroup pet Previewable email templates module integrations.
 *
 * Module integrations with the Previewable email templates module.
 */

/**
 * @defgroup pet_hooks Previewable email templates hooks
 * @{
 * Hooks that can be implemented by other modules in order to extend Previewable email templates.
 */

/**
 * Add custom token objects.
 *
 * Modules can implement this hook to provide additional token objects for
 * substitution by Pet during an email send.
 */
function hook_pet_substitutions_alter(&$substitutions) {

  // Make my tokens available to Pet.
  if (isset($params['node']) && $params['node']->type == 'something_or_other') {
    $substitutions['something_or_other_extra_tokens'] = MY_MODULE_something_or_other_extra_tokens($params['node']);
  }
}

/**
 * Implements hook_default_ENTITY_TYPE().
 *
 * @return array
 *   An array of default previewable email templates, keyed by machine names.
 *
 * @see hook_default_pet_alter()
 */
function hook_default_pet() {
  $defaults['some_default_pet'] = entity_create('pet', array(
    'name' => 'some_default_pet',
    'title' => 'some default pet title',
    'subject' => 'subject',
    'mail_body' => 'body default',
    'reply_to' => NULL,
    'cc' => '[e-mail]',
    'bcc' => '[e-mail]',
    'recipient_callback' => 'MY_MODULE_recipients_callback',
  ));
  return $defaults;
}

/**
 * Sample email recipient callback.
 *
 * In practice this would likely look up emails based on the node info.
 */
function MY_MODULE_recipients_callback($node = NULL) {
  return array(
    '[e-mail]',
    '[e-mail]',
  );
}

Functions

Name	Description
hook_default_pet	Implements hook_default_ENTITY_TYPE().
hook_pet_substitutions_alter	Add custom token objects.
MY_MODULE_recipients_callback	Sample email recipient callback.