You are here

class BootstrapTourEntityController in Bootstrap Tour 7.2

Class BootstrapTourEntityController

Ensure Bootstrap Tours are imported and exported with tour steps.

Hierarchy

Expanded class hierarchy of BootstrapTourEntityController

1 string reference to 'BootstrapTourEntityController'
bootstrap_tour_entity_info in ./bootstrap_tour.module
Implements hook_entity_info().

File

includes/bootstrap_tour.controller.inc, line 13
Defines the inline entity form controller for BootstrapTourStep entities.

View source
class BootstrapTourEntityController extends EntityAPIControllerExportable {
  public function export($entity, $prefix = '') {
    $wrapper = entity_metadata_wrapper('bootstrap_tour', $entity);
    if (field_info_instance('bootstrap_tour', 'bootstrap_tour_step_reference', 'bootstrap_tour')) {
      $entity->steps = $wrapper->bootstrap_tour_step_reference
        ->value();

      // Need to remove the step reference as they will be overriden anyway.
      // Remove step keys as they are ignored anyway.
      unset($entity->bootstrap_tour_step_reference);
      foreach ($entity->steps as $step) {
        unset($step->bootstrap_tour_step_id);
      }
    }
    return parent::export($entity, $prefix);
  }
  public function import($data) {
    return parent::import($data);
  }

  /**
   * Add in a presave before any else to handle imported steps.
   */
  public function invoke($hook, $entity) {

    // Handle imported steps
    if ($hook == 'presave' && !empty($entity->steps)) {
      $step_ids = array();
      if (!empty($entity->original)) {
        $step_ids = field_get_items('bootstrap_tour', $entity->original, 'bootstrap_tour_step_reference');
      }
      $steps = $entity->steps;
      unset($entity->steps);
      foreach ($steps as $index => $step) {
        $new_step = entity_create('bootstrap_tour_step', array(
          'path' => isset($step['path']) ? $step['path'] : '',
          'selector' => $step['selector'],
          'placement' => $step['placement'],
          'title' => $step['title'],
          'content' => $step['content'],
          'content_text_format' => $step['content_text_format'],
        ));

        // If a step of index ID existed, use existing id.
        if (!empty($step_ids[$index])) {
          $new_step->bootstrap_tour_step_id = $step_ids[$index]['target_id'];
          unset($new_step->is_new);
          unset($step_ids[$index]);
        }
        $new_step
          ->save();
        $entity->bootstrap_tour_step_reference[LANGUAGE_NONE][$index]['target_id'] = $new_step ? $new_step->bootstrap_tour_step_id : NULL;
      }

      // Delete any orphaned steps.
      if ($step_ids) {
        entity_delete_multiple('bootstrap_tour_step', $step_ids);
      }
    }
    parent::invoke($hook, $entity);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BootstrapTourEntityController::export public function Overridden. Overrides EntityAPIControllerExportable::export
BootstrapTourEntityController::import public function Implements EntityAPIControllerInterface. Overrides EntityAPIController::import
BootstrapTourEntityController::invoke public function Add in a presave before any else to handle imported steps. Overrides EntityAPIControllerExportable::invoke
DrupalDefaultEntityController::$cache protected property Whether this entity type should use the static cache.
DrupalDefaultEntityController::$entityCache protected property Static cache of entities, keyed by entity ID.
DrupalDefaultEntityController::$entityInfo protected property Array of information about the entity.
DrupalDefaultEntityController::$entityType protected property Entity type for this controller instance.
DrupalDefaultEntityController::$hookLoadArguments protected property Additional arguments to pass to hook_TYPE_load().
DrupalDefaultEntityController::$idKey protected property Name of the entity's ID field in the entity database table.
DrupalDefaultEntityController::$revisionKey protected property Name of entity's revision database table field, if it supports revisions.
DrupalDefaultEntityController::$revisionTable protected property The table that stores revisions, if the entity supports revisions.
DrupalDefaultEntityController::cleanIds protected function Ensures integer entity IDs are valid.
DrupalDefaultEntityController::filterId protected function Callback for array_filter that removes non-integer IDs.
EntityAPIController::$bundleKey protected property
EntityAPIController::$cacheComplete protected property
EntityAPIController::$defaultRevisionKey protected property
EntityAPIController::buildContent public function Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::buildContent
EntityAPIController::create public function Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::create
EntityAPIController::deleteRevision public function Implements EntityAPIControllerRevisionableInterface::deleteRevision(). Overrides EntityAPIControllerRevisionableInterface::deleteRevision
EntityAPIController::query public function Builds and executes the query for loading.
EntityAPIController::renderEntityProperty protected function Renders a single entity property.
EntityAPIController::saveRevision protected function Saves an entity revision.
EntityAPIControllerExportable::$entityCacheByName protected property
EntityAPIControllerExportable::$nameKey protected property
EntityAPIControllerExportable::applyConditions protected function
EntityAPIControllerExportable::attachLoad protected function Overridden. Overrides DrupalDefaultEntityController::attachLoad
EntityAPIControllerExportable::buildQuery protected function Support loading by name key. Overrides EntityAPIController::buildQuery
EntityAPIControllerExportable::cacheGet protected function Overridden. Overrides DrupalDefaultEntityController::cacheGet
EntityAPIControllerExportable::cacheGetByName protected function Like cacheGet() but keyed by name.
EntityAPIControllerExportable::cacheSet protected function Overridden. Overrides DrupalDefaultEntityController::cacheSet
EntityAPIControllerExportable::delete public function Overridden to care about reverted entities. Overrides EntityAPIController::delete
EntityAPIControllerExportable::load public function Overridden to support passing numeric ids as well as names as $ids. Overrides EntityAPIController::load
EntityAPIControllerExportable::resetCache public function Overrides DrupalDefaultEntityController::resetCache(). Overrides EntityAPIController::resetCache
EntityAPIControllerExportable::save public function Overridden to care exportables that are overridden. Overrides EntityAPIController::save
EntityAPIControllerExportable::view public function Implements EntityAPIControllerInterface. Overrides EntityAPIController::view
EntityAPIControllerExportable::__construct public function Overridden. Overrides EntityAPIController::__construct