entity_validator.module

<?php

/**
 * @file
 * Programmatically validate entities.
 */

/**
 * Implements hook_ctools_plugin_type().
 */
function entity_validator_ctools_plugin_type() {
  $plugins['validator'] = array(
    'classes' => array('class'),
    'process' => 'entity_validator_plugin_process',
  );
  $plugins['validator']['child plugins'] = TRUE;

  return $plugins;
}

/**
 * Add defaults values to the validator plugins.
 *
 * Properties for the "validator" plugin type:
 * - name: Set the name based on the entity type and bundle.
 * - description: The description of the plugin. Defaults to empty string.
 * - options: Array of options needed for the plugin.
 */
function entity_validator_plugin_process(&$plugin, $info) {
  $plugin += array(
    'description' => '',
    'options' => array(),
  );
}
/**
 * Include CTools plugins and get all entity validator plugins.
 *
 * @return array
 *   All plugins relate to entity validator.
 */
function entity_validator_get_validator_plugins() {
  ctools_include('plugins');
  return ctools_get_plugins('entity_validator', 'validator');
}

/**
 * Include CTools plugins and get the specified entity validator plugin.
 *
 * @param string $plugin_name
 *   If provided this function only returns the selected plugin.
 *
 * @return array
 *   The selected plugin for entity validator.
 */
function entity_validator_get_validator_plugin($plugin_name) {
  ctools_include('plugins');
  return ctools_get_plugins('entity_validator', 'validator', $plugin_name);
}

/**
 * Return the validation handler based on entity type and bundle.
 *
 * @param $entity_type
 *   The entity type.
 * @param $bundle
 *   The bundle name.
 *
 * @return EntityValidateInterface | NULL
 *  The handler object if found, or NULL.
 */
function entity_validator_get_validator_handler($entity_type, $bundle) {
  $plugin_name = $entity_type . '__' . $bundle;
  $plugin = entity_validator_get_validator_plugin($plugin_name);

  if (!$class = ctools_plugin_load_class('entity_validator', 'validator', $plugin_name, 'class')) {
    return NULL;
  }

  $handler = new $class($plugin);
  return $handler;
}

/**
 * Return the validation handler for schema validator.
 *
 * @param $plugin_name
 *   The name of the validator.
 *
 * @return ObjectValidateInterface | NULL
 *   The validator object.
 */
function entity_validator_get_schema_validator($plugin_name) {
  $plugin = entity_validator_get_validator_plugin($plugin_name);

  if (!$class = ctools_plugin_load_class('entity_validator', 'validator', $plugin_name, 'class')) {
    return NULL;
  }

  $handler = new $class($plugin);
  return $handler;
}