interface ContentTypeInterface in Opigno group manager 3.x

Interface ContentTypeInterface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\opigno_group_manager\ContentTypeInterface

File

src/ContentTypeInterface.php, line 11

Namespace

Drupal\opigno_group_manager

interface ContentTypeInterface extends PluginInspectionInterface {

  /**
   * Get the URL object of the main view page of a specific entity.
   *
   * @param int $entity_id
   *   The entity ID.
   *
   * @return \Drupal\Core\Url
   *   The tool entity URL.
   */
  public function getViewContentUrl($entity_id);

  /**
   * Get the score of the user for a specific entity.
   *
   * @param int $user_id
   *   The user ID.
   * @param int $entity_id
   *   The entity ID.
   *
   * @return float|false
   *   The score between 0 and 1. FALSE if no score found.
   */
  public function getUserScore($user_id, $entity_id);

  /**
   * Get the entity as a LearningPathContent.
   *
   * @param int $entity_id
   *   The entity ID.
   *
   * @return LearningPathContent|false
   *   The content loaded in a LearningPathContent.
   *   FALSE if not possible to load.
   */
  public function getContent($entity_id);

  /**
   * Get all the published entities in an array of LearningPathContent.
   *
   * @return LearningPathContent[]|false
   *   The published contents or FALSE in case of error.
   */
  public function getAvailableContents();

  /**
   * Get all the entities in an array of LearningPathContent.
   *
   * @return LearningPathContent[]|false
   *   The contents or FALSE in case of error.
   */
  public function getAllContents();

  /**
   * Try to get the content from a Request object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return LearningPathContent|false
   *   The content if possible. FALSE otherwise.
   */
  public function getContentFromRequest(Request $request);

  /**
   * Get the form object based on the entity ID.
   *
   * If no entity given in parameter,
   * return the entity creation form object.
   *
   * @param int $entity_id
   *   The entity ID.
   *
   * @return \Drupal\Core\Entity\EntityFormInterface
   *   Form.
   */
  public function getFormObject($entity_id = NULL);

  /**
   * Return TRUE if the page should show the "next" action button.
   *
   * Even if the score does not permit the user to go next.
   *
   * Returning TRUE will not automatically show the button.
   * The button will show up only if this method returns
   * TRUE and if there is a next step available
   * and if the user is able to go to this next content.
   *
   * @return bool
   *   Next.
   */
  public function shouldShowNext();

}

Members

Name	Modifiers	Type	Description	Overrides
ContentTypeInterface::getAllContents	public	function	Get all the entities in an array of LearningPathContent.
ContentTypeInterface::getAvailableContents	public	function	Get all the published entities in an array of LearningPathContent.
ContentTypeInterface::getContent	public	function	Get the entity as a LearningPathContent.
ContentTypeInterface::getContentFromRequest	public	function	Try to get the content from a Request object.
ContentTypeInterface::getFormObject	public	function	Get the form object based on the entity ID.
ContentTypeInterface::getUserScore	public	function	Get the score of the user for a specific entity.
ContentTypeInterface::getViewContentUrl	public	function	Get the URL object of the main view page of a specific entity.
ContentTypeInterface::shouldShowNext	public	function	Return TRUE if the page should show the "next" action button.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2