interface SocialProfileTagServiceInterface in Open Social 10.3.x

Interface SocialProfileTagServiceInterface.

@package Drupal\social_profile

Hierarchy

• interface \Drupal\social_profile\SocialProfileTagServiceInterface

2 files declare their use of SocialProfileTagServiceInterface

SocialProfileTagSplitWidget.php in modules/social_features/social_profile/src/Plugin/Field/FieldWidget/SocialProfileTagSplitWidget.php

SocialSearchApiSplitProfileTerms.php in modules/social_features/social_profile/src/Plugin/views/filter/SocialSearchApiSplitProfileTerms.php

File

modules/social_features/social_profile/src/SocialProfileTagServiceInterface.php, line 10

Namespace

Drupal\social_profile

interface SocialProfileTagServiceInterface {

  /**
   * Returns whether the feature is turned on or not.
   *
   * @return bool
   *   Whether tagging is turned on or not.
   */
  public function isActive();

  /**
   * Returns if there are any taxonomy items available.
   *
   * @return bool
   *   If there are tags available.
   */
  public function hasContent();

  /**
   * Returns whether splitting of fields is allowed.
   *
   * @return bool
   *   Whether category split on field level is turned on or not.
   */
  public function allowSplit();

  /**
   * Returns all the top level term items, that are considered categories.
   *
   * @return array
   *   An array of top level category items.
   */
  public function getCategories();

  /**
   * Returns the children of top level term items.
   *
   * @param int $category
   *   The category you want to fetch the child items from.
   *
   * @return array
   *   An array of child items.
   */
  public function getChildrens($category);

  /**
   * Returns whether using a parent of categories is allowed.
   *
   * @return bool
   *   Whether using categories parent is turned on or not..
   */
  public function useCategoryParent();

  /**
   * Returns converted tag name to machine readable.
   *
   * @param string $label
   *   Label of term.
   *
   * @return string
   *   Tag machine name.
   */
  public function tagLabelToMachineName($label);

  /**
   * Returns a multilevel tree.
   *
   * @param array $term_ids
   *   An array of items that are selected.
   *
   * @return array
   *   An hierarchy array of items with their parent.
   */
  public function buildHierarchy(array $term_ids);

  /**
   * Returns list of term names as option list.
   *
   * @param array $term_ids
   *   List of taxonomy term IDs.
   *
   * @return array
   *   Options.
   */
  public function getTermOptionNames(array $term_ids);

}

Members

Name	Modifiers	Type	Description	Overrides
SocialProfileTagServiceInterface::allowSplit	public	function	Returns whether splitting of fields is allowed.	1
SocialProfileTagServiceInterface::buildHierarchy	public	function	Returns a multilevel tree.	1
SocialProfileTagServiceInterface::getCategories	public	function	Returns all the top level term items, that are considered categories.	1
SocialProfileTagServiceInterface::getChildrens	public	function	Returns the children of top level term items.	1
SocialProfileTagServiceInterface::getTermOptionNames	public	function	Returns list of term names as option list.	1
SocialProfileTagServiceInterface::hasContent	public	function	Returns if there are any taxonomy items available.	1
SocialProfileTagServiceInterface::isActive	public	function	Returns whether the feature is turned on or not.	1
SocialProfileTagServiceInterface::tagLabelToMachineName	public	function	Returns converted tag name to machine readable.	1
SocialProfileTagServiceInterface::useCategoryParent	public	function	Returns whether using a parent of categories is allowed.	1