class crumbs_InjectedAPI_Collection_EntityPluginCollection in Crumbs, the Breadcrumbs suite 7.2

Hierarchy

• class \crumbs_InjectedAPI_Collection_EntityPluginCollection

See also

crumbs_InjectedAPI_hookCrumbsPlugins

File

lib/InjectedAPI/Collection/EntityPluginCollection.php, line 6

class crumbs_InjectedAPI_Collection_EntityPluginCollection {

  /**
   * @var array
   *   Known routes for entity types, e.g.:
   *   $this->entityRoutes['node/%'] = array('node', 'type', 'Node type');
   */
  protected $entityRoutes = array();

  /**
   * @var array
   *   Collection of entity plugins. Format:
   *   $this->entityPlugins[$type][$module . '.' . $key] = array($entity_plugin, $types);
   */
  protected $entityPlugins = array();

  /**
   * @param crumbs_InjectedAPI_Collection_PluginCollection $pluginCollection
   */
  function finalize(crumbs_InjectedAPI_Collection_PluginCollection $pluginCollection) {
    $build = array();
    foreach ($this->entityPlugins as $type => $plugins) {
      foreach ($plugins as $key => $y) {
        list($entity_plugin, $types) = $y;
        if (!isset($types)) {
          foreach ($this->entityRoutes as $route => $x) {
            list($entity_type) = $x;
            $build[$entity_type][$type][$key . '.' . $entity_type] = $entity_plugin;
          }
        }
        elseif (is_array($types)) {
          foreach ($types as $entity_type) {
            $build[$entity_type][$type][$key . '.' . $entity_type] = $entity_plugin;
          }
        }
        elseif (is_string($types)) {
          $entity_type = $types;
          $build[$entity_type][$type][$key] = $entity_plugin;
        }
      }
    }
    foreach ($this->entityRoutes as $route => $x) {
      list($entity_type, $bundle_key, $bundle_name) = $x;
      if (!empty($build[$entity_type])) {
        foreach ($build[$entity_type] as $type => $plugins) {
          foreach ($plugins as $key => $entity_plugin) {
            if ('parent' === $type) {
              $plugin = new crumbs_MultiPlugin_EntityParent($entity_plugin, $entity_type, $bundle_key, $bundle_name);
              $pluginCollection
                ->addPlugin($plugin, $key, $route);
            }
            else {
              $plugin = new crumbs_MultiPlugin_EntityTitle($entity_plugin, $entity_type, $bundle_key, $bundle_name);
              $pluginCollection
                ->addPlugin($plugin, $key, $route);
            }
          }
        }
      }
    }
  }

  /**
   * Register an entity route.
   * This should be called by those modules that define entity types and routes.
   *
   * @param string $entity_type
   * @param string $route
   * @param string $bundle_key
   * @param string $bundle_name
   */
  function entityRoute($entity_type, $route, $bundle_key, $bundle_name) {
    $this->entityRoutes[$route] = array(
      $entity_type,
      $bundle_key,
      $bundle_name,
    );
  }

  /**
   * @param string $type
   *   Either 'title' or 'parent'.
   * @param string $key
   *   The plugin key under which this callback will be listed on the weights
   *   configuration form.
   * @param crumbs_EntityPlugin $entity_plugin
   * @param string[]|string|null $types
   *   An array of entity types, or a single entity type, or NULL to allow all
   *   entity types.
   */
  function entityPlugin($type, $key, crumbs_EntityPlugin $entity_plugin, $types) {
    if ($entity_plugin instanceof crumbs_EntityPlugin) {
      $this->entityPlugins[$type][$key] = array(
        $entity_plugin,
        $types,
      );
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_InjectedAPI_Collection_EntityPluginCollection::$entityPlugins	protected	property	Collection of entity plugins. Format: $this->entityPlugins[$type][$module . '.' . $key] = array($entity_plugin, $types);
crumbs_InjectedAPI_Collection_EntityPluginCollection::$entityRoutes	protected	property	Known routes for entity types, e.g.: $this->entityRoutes['node/%'] = array('node', 'type', 'Node type');
crumbs_InjectedAPI_Collection_EntityPluginCollection::entityPlugin		function
crumbs_InjectedAPI_Collection_EntityPluginCollection::entityRoute		function	Register an entity route. This should be called by those modules that define entity types and routes.
crumbs_InjectedAPI_Collection_EntityPluginCollection::finalize		function