You are here

interface ContentRepositoryInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/symfony-cmf/routing/ContentRepositoryInterface.php \Symfony\Cmf\Component\Routing\ContentRepositoryInterface

Interface used by the DynamicRouter to retrieve content by it's id when generating routes from content-id.

This can be easily implemented using i.e. the Doctrine PHPCR-ODM DocumentManager.

@author Uwe Jäger

Hierarchy

Expanded class hierarchy of ContentRepositoryInterface

All classes that implement ContentRepositoryInterface

File

vendor/symfony-cmf/routing/ContentRepositoryInterface.php, line 23

Namespace

Symfony\Cmf\Component\Routing
View source
interface ContentRepositoryInterface {

  /**
   * Return a content object by it's id or null if there is none.
   *
   * If the returned content implements RouteReferrersReadInterface, it will
   * be used to get the route from it to generate an URL.
   *
   * @param string $id id of the content object
   *
   * @return object A content that matches this id.
   */
  public function findById($id);

  /**
   * Return the content identifier for the provided content object for
   * debugging purposes.
   *
   * @param object $content A content instance
   *
   * @return string|null $id id of the content object or null if unable to determine an id
   */
  public function getContentId($content);

}

Members

Namesort descending Modifiers Type Description Overrides
ContentRepositoryInterface::findById public function Return a content object by it's id or null if there is none.
ContentRepositoryInterface::getContentId public function Return the content identifier for the provided content object for debugging purposes.