interface ExcludeNodeTitleManagerInterface in Exclude Node Title 8

Defines methods to manage Exclude Node Title settings.

Hierarchy

• interface \Drupal\exclude_node_title\ExcludeNodeTitleManagerInterface

1 file declares its use of ExcludeNodeTitleManagerInterface

AdminSettingsForm.php in src/Form/AdminSettingsForm.php

File

src/ExcludeNodeTitleManagerInterface.php, line 8

Namespace

Drupal\exclude_node_title

interface ExcludeNodeTitleManagerInterface {

  /**
   * Loads exclude mode for node type.
   *
   * @param mixed $param
   *   Can be NodeTypeInterface object or machine name.
   *
   * @return string
   *   Exclude mode.
   */
  public function getBundleExcludeMode($param);

  /**
   * Loads excluded view modes for node type.
   *
   * @param mixed $param
   *   Can be NodeTypeInterface object or machine name.
   *
   * @return array
   *   View modes.
   */
  public function getExcludedViewModes($param);

  /**
   * Loads excluded node ids list.
   *
   * @return array
   *   Nodes identifiers list.
   */
  public function getExcludedNodes();

  /**
   * Helper function to that extracts node information from $param.
   *
   * @param mixed $param
   *   Can be a NodeInterface object or integer value (nid).
   *
   * @return mixed
   *   Returns an array with node id and node type, or FALSE if errors exist.
   */
  public function getNodeInfo($param);

  /**
   * Checks if exclude from Search elements is enabled.
   *
   * @return bool
   *   Enabled status.
   */
  public function isSearchExcluded();

  /**
   * Tells if node should get hidden or not.
   *
   * @param mixed $param
   *   Can be a node object or integer value (nid).
   * @param string $view_mode
   *   Node view mode to check.
   *
   * @return bool
   *   Returns boolean TRUE if should be hidden, FALSE when not.
   */
  public function isTitleExcluded($param, $view_mode = 'full');

  /**
   * Tells if node is in exclude list.
   *
   * @param mixed $param
   *   Can be a node object or integer value (nid).
   */
  public function isNodeExcluded($param);

  /**
   * Remove the title from the variables array.
   *
   * @param mixed $vars
   *   Theme function variables.
   * @param mixed $node
   *   Can be NodeInterface object or integer id.
   * @param string $view_mode
   *   View mode name.
   */
  public function preprocessTitle(&$vars, $node, $view_mode);

  /**
   * Adds node to exclude list.
   *
   * @param mixed $param
   *   Can be a node object or integer value (nid).
   */
  public function addNodeToList($param);

  /**
   * Removes node exclude list.
   *
   * @param mixed $param
   *   Can be a node object or integer value (nid).
   */
  public function removeNodeFromList($param);

}

Members

Name	Modifiers	Type	Description	Overrides
ExcludeNodeTitleManagerInterface::addNodeToList	public	function	Adds node to exclude list.	1
ExcludeNodeTitleManagerInterface::getBundleExcludeMode	public	function	Loads exclude mode for node type.	1
ExcludeNodeTitleManagerInterface::getExcludedNodes	public	function	Loads excluded node ids list.	1
ExcludeNodeTitleManagerInterface::getExcludedViewModes	public	function	Loads excluded view modes for node type.	1
ExcludeNodeTitleManagerInterface::getNodeInfo	public	function	Helper function to that extracts node information from $param.	1
ExcludeNodeTitleManagerInterface::isNodeExcluded	public	function	Tells if node is in exclude list.	1
ExcludeNodeTitleManagerInterface::isSearchExcluded	public	function	Checks if exclude from Search elements is enabled.	1
ExcludeNodeTitleManagerInterface::isTitleExcluded	public	function	Tells if node should get hidden or not.	1
ExcludeNodeTitleManagerInterface::preprocessTitle	public	function	Remove the title from the variables array.	1
ExcludeNodeTitleManagerInterface::removeNodeFromList	public	function	Removes node exclude list.	1