eck.property_behavior.inc in Entity Construction Kit (ECK) 7.3

Property Behaviors.

Behaviors are groupings of logic that can be attached to a property.

File

eck.property_behavior.inc

<?php

/**
 * @file
 * Property Behaviors.
 *
 * Behaviors are groupings of logic that can be attached to a property.
 */

/**
 * Each if a behavior is implemented.
 *
 * This function checks whether a property is implementing any of the supported
 * property behavior functions.
 *
 * @todo I think this function could simplify the code of
 * eck_property_behavior_invoke_plugin and alter().
 */
function eck_property_behavior_implements($entity_type, $property, $function_name) {
  $properties = $entity_type->properties;
  $info = $entity_type->properties[$property];
  $return = FALSE;
  if (array_key_exists('behavior', $info) && !empty($info['behavior'])) {
    $behavior = $info['behavior'];
    $plugin = ctools_get_plugins('eck', 'property_behavior', $behavior);
    $function = ctools_plugin_get_function($plugin, $function_name);
    if ($function) {
      $return = $function;
    }
  }
  return $return;
}

/**
 * A general function to call specific functions in a property behavior plugin.
 */
function eck_property_behavior_invoke_plugin($entity_type, $function_name, $all = array(), $specific = array()) {
  $properties = $entity_type->properties;
  $returns = array();
  foreach ($properties as $property => $info) {

    // If there is a behavior associated with this property we need to call the
    // appropiate hooks.
    if (array_key_exists('behavior', $info) && !empty($info['behavior'])) {
      $behavior = $info['behavior'];
      $plugin = ctools_get_plugins('eck', 'property_behavior', $behavior);
      $function = ctools_plugin_get_function($plugin, $function_name);
      if ($function) {
        if (array_key_exists($property, $specific)) {
          $return = $function($property, array_merge($all, $specific[$property]));
        }
        else {
          $return = $function($property, $all);
        }
        if ($return) {
          $returns[$property] = $return;
        }
      }
    }
  }
  return $returns;
}

/**
 * A general function for beahaviors that are meant to alter data.
 *
 * @param EntityType $entity_type
 *   The entity type object.
 * @param string $function_name
 *   the name of the sub_hook.
 * @param array $var
 *   Variable to be altered.
 *
 * @return array
 *   most likely, an array returned by a plugin.
 */
function eck_property_behavior_invoke_plugin_alter($entity_type, $function_name, $var) {
  $properties = $entity_type->properties;
  $return = $var;
  foreach ($properties as $property => $info) {

    // If there is a behavior associated with this property we need to call
    // the appropiate hooks.
    if (array_key_exists('behavior', $info) && !empty($info['behavior'])) {
      $behavior = $info['behavior'];
      $plugin = ctools_get_plugins('eck', 'property_behavior', $behavior);
      $function = ctools_plugin_get_function($plugin, $function_name);
      if ($function) {
        if (array_key_exists('behavior_config', $info)) {
          $return['config'] = $info['behavior_config'];
        }
        $return = $function($property, $return);
      }
    }
  }
  return $return;
}

/**
 * Property behavior setter.
 */
function eck_property_behavior_setter(&$data, $name, $value, $langcode, $type, $info) {
  $entity = $data;
  $entity_type_name = $entity
    ->entityType();
  $entity_type = EntityType::loadByName($entity_type_name);
  $property = $name;
  $function = eck_property_behavior_implements($entity_type, $property, 'setter');
  if ($function) {
    return $function($property, array(
      'entity' => $entity,
      'value' => $value,
    ));
  }
}

/**
 * Property behavior getter.
 */
function eck_property_behavior_getter($data, array $options, $name, $type, $info) {
  $entity = $data;
  $entity_type_name = $entity
    ->entityType();
  $entity_type = EntityType::loadByName($entity_type_name);
  $property = $name;
  $function = eck_property_behavior_implements($entity_type, $property, 'getter');
  if ($function) {
    return $function($property, array(
      'entity' => $entity,
    ));
  }
}

/**
 * Property behavior validation.
 */
function eck_property_behavior_validation($value, $info) {
  $entity = $info['parent']
    ->value();
  $entity_type_name = $entity
    ->entityType();
  $entity_type = EntityType::loadByName($entity_type_name);
  $property = $info['schema field'];
  $function = eck_property_behavior_implements($entity_type, $property, 'validation');
  if ($function) {
    return $function($property, array(
      'value' => $value,
    ));
  }
}

/**
 * Property behavior form.
 */
function eck__property_behavior__form($form, &$state, $entity_type_name, $property) {
  $entity_type = EntityType::loadByName($entity_type_name);
  $properties = $entity_type->properties;
  if (array_key_exists($property, $properties)) {
    $form['entity_type'] = array(
      '#type' => 'value',
      '#value' => $entity_type,
    );
    $form['property'] = array(
      '#type' => 'value',
      '#value' => $property,
    );
    ctools_include("plugins");
    $plugins = ctools_get_plugins("eck", "property_behavior");
    $behaviors = array(
      '_ NONE _',
    );
    $behaviors = array_merge($behaviors, array_keys($plugins));
    $form['behaviors'] = array(
      '#type' => 'value',
      '#value' => $behaviors,
    );
    $key = array_search($properties[$property]['behavior'], $behaviors);

    // We can have 3 possible states,
    // 1) there is no behavior for the property and non has been selected for
    // configuration.
    // 2) there is no behavior for the property, but one has been chosen to be
    // configured.
    // 3) This property has a behavior already.
    // Has a behavior been selected?
    $behavior = FALSE;
    if (array_key_exists('values', $state)) {
      $values = $state['values'];
      $behavior = $values['behavior'];
    }
    if (!$key && !$behavior) {
      $form['behavior'] = array(
        '#title' => 'behavior',
        '#type' => 'select',
        '#options' => $behaviors,
        '#default_value' => $key,
      );
      $form['configure'] = array(
        '#type' => 'submit',
        '#weight' => 10000,
        '#value' => t('Configure'),
      );
    }
    elseif (!$key && $behavior) {
      $form['behavior'] = array(
        '#title' => 'behavior',
        '#type' => 'select',
        '#options' => $behaviors,
        '#default_value' => $key,
      );

      // Need to get the behaviors configuration form.
      $behavior_name = $behaviors[$behavior];
      $function = ctools_plugin_get_function($plugins[$behavior_name], "config_form");
      if ($function) {
        $config_form = $function();
        foreach ($config_form as $key => $element) {
          unset($config_form[$key]);
          $config_form["config_{$key}"] = $element;
        }
      }
      if (isset($config_form)) {
        $form['config_form_wrapper'] = array(
          '#type' => 'fieldset',
          '#title' => "Configure Behavior",
        );
        $form['config_form_wrapper']['config_form'] = $config_form;
      }
      $form['submit'] = array(
        '#type' => 'submit',
        '#weight' => 10000,
        '#value' => t('Save'),
      );
    }
    else {
      $form['behavior'] = array(
        '#markup' => "<h3>{$behaviors[$key]}</h3>",
      );
      $form['remove'] = array(
        '#type' => 'submit',
        '#weight' => 10000,
        '#value' => t('Remove'),
      );
    }
  }
  else {
    drupal_set_message('This property does not exists');
    drupal_goto(eck__entity_type__path() . "/{$entity_type->name}/property");
  }
  return $form;
}

/**
 * Property behavior get config values.
 */
function eck_property_behavior_get_config_values($values) {
  $config = array();
  foreach ($values as $key => $value) {
    if (substr_count($key, "config_") > 0) {
      $new_key = str_replace("config_", "", $key);
      $config[$new_key] = $value;
    }
  }
  return $config;
}

/**
 * Property behavior form submit.
 */
function eck__property_behavior__form_submit($form, &$state) {
  if ($state['values']['op'] == "Configure") {
    $state['rebuild'] = TRUE;
  }
  else {
    $values = $state['values'];
    $behavior_config = eck_property_behavior_get_config_values($values);
    $entity_type = $values['entity_type'];
    $property = $values['property'];
    $behaviors = $values['behaviors'];
    $behavior = array_key_exists('behavior', $values) ? $values['behavior'] : FALSE;
    $properties = $entity_type->properties;
    if ($behavior != 0) {
      $properties[$property]['behavior'] = $behaviors[$behavior];
      if (!empty($behavior_config)) {
        $properties[$property]['behavior_config'] = $behavior_config;
      }
      $entity_type->properties = $properties;
    }
    else {
      $properties[$property]['behavior'] = NULL;
      $entity_type->properties = $properties;
    }
    $entity_type
      ->save();
    EntityType::loadAll(NULL, TRUE);
    $state['redirect'] = eck__entity_type__path() . "/{$entity_type->name}/property";
  }
}

Functions

Name	Description
eck_property_behavior_getter	Property behavior getter.
eck_property_behavior_get_config_values	Property behavior get config values.
eck_property_behavior_implements	Each if a behavior is implemented.
eck_property_behavior_invoke_plugin	A general function to call specific functions in a property behavior plugin.
eck_property_behavior_invoke_plugin_alter	A general function for beahaviors that are meant to alter data.
eck_property_behavior_setter	Property behavior setter.
eck_property_behavior_validation	Property behavior validation.
eck__property_behavior__form	Property behavior form.
eck__property_behavior__form_submit	Property behavior form submit.