class OgVocab in OG Vocabulary 7

@file A class used for messages.

Hierarchy

class \Entity implements EntityInterface
- class \OgVocab

Expanded class hierarchy of OgVocab

1 string reference to 'OgVocab'

og_vocab_entity_info in ./og_vocab.module: Implements hook_entity_info().

File

includes/og_vocab.og_vocab.inc, line 9: A class used for messages.

View source

class OgVocab extends Entity {

  /**
   * The entity type.
   *
   * @var string
   */
  public $entity_type;

  /**
   * The bundle.
   *
   * @var string
   */
  public $bundle;

  /**
   * The OG-vocab settings.
   *
   * @var array
   */
  public $settings = array();
  public function __construct($values = array()) {
    $values += array();
    parent::__construct($values, 'og_vocab');
  }

  /**
   * Return form element.
   */
  public function getFormElement($entity_type, $entity, &$form, &$form_state) {
    $vid = $this->vid;
    $vocabulary = taxonomy_vocabulary_load($vid);
    $field_name = $this->field_name;
    $field = field_info_field($field_name);

    // Create a dummy entity that only holds the legal values for the
    // selected vocabulary. This is needed for autocomplete fields.
    $dummy_entity = clone $entity;
    $wrapper = entity_metadata_wrapper($entity_type, $dummy_entity);
    $rebuild_keys = FALSE;
    if ($field['cardinality'] != 1) {
      foreach ($wrapper->{$field_name}
        ->value() as $delta => $term) {
        if (empty($term)) {

          // The term has deleted, but the reference still remains in the field.
          continue;
        }
        if ($term->vid != $this->vid) {
          $wrapper->{$field_name}
            ->offsetUnset($delta);
          $rebuild_keys = TRUE;
        }
      }
    }
    if ($rebuild_keys) {
      $ids = $wrapper->{$field_name}
        ->value(array(
        'identifier' => TRUE,
      ));

      // Rebuild the deltas.
      $wrapper->{$field_name}
        ->set(array_values($ids));
    }
    ctools_include('fields');
    $mocked_field = $this
      ->getMockedField();
    $field_instance = $mocked_field['instance'];
    $field_instance['field'] = $mocked_field['field'];
    $dummy_form_state = $form_state;
    if (empty($form_state['rebuild'])) {

      // Form is "fresh" (i.e. not call from field_add_more_submit()), so
      // re-set the items-count, to show the correct amount for the mocked
      // instance.
      $dummy_form_state['field'][$field_name][LANGUAGE_NONE]['items_count'] = !empty($dummy_entity->{$field_name}[LANGUAGE_NONE]) ? count($dummy_entity->{$field_name}[LANGUAGE_NONE]) : 0;
    }
    $new_element = ctools_field_invoke_field($field_instance, 'form', $entity_type, $dummy_entity, $form, $dummy_form_state, array(
      'default' => TRUE,
    ));
    $element = $new_element[$field_name][LANGUAGE_NONE];
    if ($this->settings['widget_type'] == 'entityreference_autocomplete') {
      $element['#vid'] = $vid;
      if (!empty($element['add_more'])) {

        // Change the "Add more" button name so it adds only the needed
        // element.
        $element['add_more']['#name'] .= '__' . $vid;
      }
      foreach (array_keys($element) as $delta) {
        if (!is_numeric($delta)) {
          continue;
        }
        $sub_element =& $element[$delta]['target_id'];
        $this
          ->prepareAutoComplete($sub_element);
      }
    }
    elseif ($this->settings['widget_type'] == 'entityreference_autocomplete_tags') {
      $element['#vid'] = $vid;
      $this
        ->prepareAutoComplete($element);

      // Add own validate handler, that will be able to add "autocreate"
      // values.
      $element['#element_validate'] = array(
        '_og_vocab_autocomplete_tags_validate',
      );
    }
    $element['#element_validate'][] = 'og_vocab_sub_widget_cardinality_validate';
    $element['#og_vocab'] = $this;
    form_load_include($form_state, 'inc', 'og_vocab', '/includes/og_vocab.og_vocab');
    $form['#after_build']['og_vocab'] = 'og_vocab_element_after_build';
    $form['#validate']['og_vocab'] = 'og_vocab_element_validate';
    return $element;
  }

  /**
   * Helper function to return the field and instance settings mocked.
   *
   * Mocking the fields is done be getting the original field values, and
   * overidding them based on the "settings" key of the OG-vocab entity.
   *
   * @return
   *   Array with the field and instance arrays.
   */
  public function getMockedField() {
    $vocabulary = taxonomy_vocabulary_load($this->vid);
    $field = field_info_field($this->field_name);
    $instance = field_info_instance($this->entity_type, $this->field_name, $this->bundle);
    $mocked_field = $mocked_instance = array();
    $widget_type = $this->settings['widget_type'];
    $mocked_instance['widget']['type'] = $widget_type;

    // Set the widget's module.
    $widget_info = field_info_widget_types($widget_type);
    $mocked_instance['widget']['module'] = $widget_info['module'];
    $mocked_instance['widget']['settings'] = drupal_array_merge_deep($widget_info['settings'], $instance['widget']['settings']);

    // Set widget's auto complete path if needed.
    if (in_array($this->settings['widget_type'], array(
      'entityreference_autocomplete',
      'entityreference_autocomplete_tags',
    ))) {
      $mocked_instance['widget']['settings']['autocomplete_path'] = 'og-vocab/autocomplete/single/%entity_object';
    }

    // Set required.
    $mocked_instance['required'] = $this->settings['required'];
    $instance['label'] = check_plain($vocabulary->name);

    // Set cardinality.
    $mocked_field['cardinality'] = $this->settings['cardinality'];

    // Restrict the mocked field to the target bundle.
    $mocked_field['settings']['handler_settings']['target_bundles'][$vocabulary->machine_name] = $vocabulary->machine_name;
    $field = drupal_array_merge_deep($field, $mocked_field);
    $instance = drupal_array_merge_deep($instance, $mocked_instance);
    return array(
      'field' => $field,
      'instance' => $instance,
    );
  }

  /**
   * Helper function; Re-create the autocomplete path.
   *
   * @param $sub_element
   *   The element that should be changed, passed by reference.
   */
  public function prepareAutoComplete(&$sub_element) {

    // Rebuild the autocomplete path.
    $path = explode('/', $sub_element['#autocomplete_path']);
    $sub_element['#autocomplete_path'] = 'og-vocab/autocomplete';

    // Add autocomplete type
    $sub_element['#autocomplete_path'] .= "/{$path[2]}";

    // Add the OG-vocab entity ID.
    $sub_element['#autocomplete_path'] .= "/{$this->id}";

    // Add the entity ID.
    $sub_element['#autocomplete_path'] .= "/{$path[6]}";
    if (!empty($path[7])) {

      // Add the text.
      $sub_element['#autocomplete_path'] .= "/{$path[7]}";
    }
  }

  /**
   * Overrides Entity::save().
   */
  public function save() {

    // Add the OG-vocabulary field in the group-content, in case it
    // doesn't already exist.
    if (empty($this->field_name)) {
      $og_vocab_fields = og_vocab_get_og_vocab_fields($this->entity_type, $this->bundle);
      $this->field_name = !empty($og_vocab_fields) ? key($og_vocab_fields) : OG_VOCAB_FIELD;
    }
    if (!field_info_instance($this->entity_type, $this->field_name, $this->bundle)) {

      // Add the new field.
      $og_info = og_fields_info(OG_VOCAB_FIELD);
      og_create_field($this->field_name, $this->entity_type, $this->bundle, $og_info);
    }
    parent::save();
  }

  /**
   * Overrides Entity::delete().
   */
  public function delete() {
    if (variable_get('og_use_queue', FALSE)) {

      // Add item to the queue.
      $group = og_vocab_relation_get($this->vid);
      $data = array(
        'vid' => $this->vid,
        'entity_type' => $this->entity_type,
        'bundle' => $this->bundle,
        'field_name' => $this->field_name,
        'group_type' => $group->group_type,
        'gid' => $group->gid,
        // The last processed OG-membership ID.
        'last_id' => 0,
      );
      $queue = DrupalQueue::get('og_vocab');
      $queue
        ->createItem($data);
    }

    // After defining the item data, if we used queue, delete the entity.
    parent::delete();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
OgVocab::$bundle	public	property	The bundle.
OgVocab::$entity_type	public	property	The entity type.
OgVocab::$settings	public	property	The OG-vocab settings.
OgVocab::delete	public	function	Overrides Entity::delete(). Overrides Entity::delete
OgVocab::getFormElement	public	function	Return form element.
OgVocab::getMockedField	public	function	Helper function to return the field and instance settings mocked.
OgVocab::prepareAutoComplete	public	function	Helper function; Re-create the autocomplete path.
OgVocab::save	public	function	Overrides Entity::save(). Overrides Entity::save
OgVocab::__construct	public	function	Overrides Entity::__construct

You are here

class OgVocab in OG Vocabulary 7

Hierarchy

File

Members

API Navigation