You are here

interface ContributorPropertiesServiceInterface in Bibliography & Citation 8

Same name and namespace in other branches
  1. 2.0.x modules/bibcite_entity/src/ContributorPropertiesServiceInterface.php \Drupal\bibcite_entity\ContributorPropertiesServiceInterface

Interface HelpInterface.

@package Drupal\bibcite

Hierarchy

Expanded class hierarchy of ContributorPropertiesServiceInterface

All classes that implement ContributorPropertiesServiceInterface

1 file declares its use of ContributorPropertiesServiceInterface
ContributorWidget.php in modules/bibcite_entity/src/Plugin/Field/FieldWidget/ContributorWidget.php

File

modules/bibcite_entity/src/ContributorPropertiesServiceInterface.php, line 16

Namespace

Drupal\bibcite_entity
View source
interface ContributorPropertiesServiceInterface {

  /**
   * Get first element of category list.
   *
   * @return string|null
   *   Default category string.
   */
  public function getDefaultCategory();

  /**
   * Get first element of role list.
   *
   * @return string|null
   *   Default role string.
   */
  public function getDefaultRole();

  /**
   * Get list of contributor categories.
   *
   * @return array
   *   Contributor categories.
   */
  public function getCategories();

  /**
   * Get list of contributor roles.
   *
   * @return array
   *   Contributor roles.
   */
  public function getRoles();

  /**
   * Sort callback for config entities with weight parameter.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface $entity_first
   *   First entity to compare.
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface $entity_second
   *   Second entity to compare.
   *
   * @return int
   *   Sort result.
   */
  public function sortByWeightProperty(ConfigEntityInterface $entity_first, ConfigEntityInterface $entity_second);

}

Members

Namesort descending Modifiers Type Description Overrides
ContributorPropertiesServiceInterface::getCategories public function Get list of contributor categories. 1
ContributorPropertiesServiceInterface::getDefaultCategory public function Get first element of category list. 1
ContributorPropertiesServiceInterface::getDefaultRole public function Get first element of role list. 1
ContributorPropertiesServiceInterface::getRoles public function Get list of contributor roles. 1
ContributorPropertiesServiceInterface::sortByWeightProperty public function Sort callback for config entities with weight parameter. 1