class ContributorPropertiesService in Bibliography & Citation 8

Class ContributorPropertiesService.

@package Drupal\bibcite

Hierarchy

• class \Drupal\bibcite_entity\ContributorPropertiesService implements ContributorPropertiesServiceInterface

1 string reference to 'ContributorPropertiesService'

bibcite_entity.services.yml in modules/bibcite_entity/bibcite_entity.services.yml

modules/bibcite_entity/bibcite_entity.services.yml

1 service uses ContributorPropertiesService

bibcite_entity.contributor_properties_service in modules/bibcite_entity/bibcite_entity.services.yml

Drupal\bibcite_entity\ContributorPropertiesService

File

modules/bibcite_entity/src/ContributorPropertiesService.php, line 13

Namespace

Drupal\bibcite_entity

class ContributorPropertiesService implements ContributorPropertiesServiceInterface {

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * Construct new UIOverrideProvider object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * Get first element of category list.
   *
   * @return string|null
   *   Default category string.
   */
  public function getDefaultCategory() {
    $list = $this
      ->getCategories();
    if (!empty($list)) {
      reset($list);
      return key($list);
    }
    else {
      return NULL;
    }
  }

  /**
   * List of roles.
   *
   * @var array
   */
  private $rolesList;

  /**
   * List of categories.
   *
   * @var array
   */
  private $categoriesList;

  /**
   * Get first element of role list.
   *
   * @return string|null
   *   Default role string.
   */
  public function getDefaultRole() {
    $list = $this
      ->getRoles();
    if (!empty($list)) {
      reset($list);
      return key($list);
    }
    else {
      return NULL;
    }
  }

  /**
   * Get list of contributor categories.
   *
   * @return array
   *   Contributor categories.
   */
  public function getCategories() {
    if (!isset($this->categoriesList)) {
      $entities = $this->entityTypeManager
        ->getStorage('bibcite_contributor_category')
        ->loadMultiple();
      uasort($entities, [
        $this,
        'sortByWeightProperty',
      ]);
      $this->categoriesList = array_map(function ($entity) {

        /** @var \Drupal\Core\Entity\EntityInterface $entity */
        return $entity
          ->label();
      }, $entities);
    }
    return $this->categoriesList;
  }

  /**
   * Get list of contributor roles.
   *
   * @return array
   *   Contributor roles.
   */
  public function getRoles() {
    if (!isset($this->rolesList)) {
      $entities = $this->entityTypeManager
        ->getStorage('bibcite_contributor_role')
        ->loadMultiple();
      uasort($entities, [
        $this,
        'sortByWeightProperty',
      ]);
      $this->rolesList = array_map(function ($entity) {

        /** @var \Drupal\Core\Entity\EntityInterface $entity */
        return $entity
          ->label();
      }, $entities);
    }
    return $this->rolesList;
  }

  /**
   * 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) {
    $weight_first = $entity_first
      ->get('weight');
    $weight_second = $entity_second
      ->get('weight');
    if ($weight_first == $weight_second) {
      return 0;
    }
    return $weight_first < $weight_second ? -1 : 1;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContributorPropertiesService::$categoriesList	private	property	List of categories.
ContributorPropertiesService::$entityTypeManager	private	property	Entity type manager.
ContributorPropertiesService::$rolesList	private	property	List of roles.
ContributorPropertiesService::getCategories	public	function	Get list of contributor categories. Overrides ContributorPropertiesServiceInterface::getCategories
ContributorPropertiesService::getDefaultCategory	public	function	Get first element of category list. Overrides ContributorPropertiesServiceInterface::getDefaultCategory
ContributorPropertiesService::getDefaultRole	public	function	Get first element of role list. Overrides ContributorPropertiesServiceInterface::getDefaultRole
ContributorPropertiesService::getRoles	public	function	Get list of contributor roles. Overrides ContributorPropertiesServiceInterface::getRoles
ContributorPropertiesService::sortByWeightProperty	public	function	Sort callback for config entities with weight parameter. Overrides ContributorPropertiesServiceInterface::sortByWeightProperty
ContributorPropertiesService::__construct	public	function	Construct new UIOverrideProvider object.