class OrganigramsController in Organigrams 8.2

Same name and namespace in other branches

8 src/Controller/OrganigramsController.php \Drupal\organigrams\Controller\OrganigramsController

Provides route responses for organigrams.module.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\organigrams\Controller\OrganigramsController

Expanded class hierarchy of OrganigramsController

2 files declare their use of OrganigramsController

organigrams.module in ./organigrams.module: Extends Taxonomy to create organigrams.
OrganigramsBlocks.php in src/Plugin/Block/OrganigramsBlocks.php

File

src/Controller/OrganigramsController.php, line 15

Namespace

Drupal\organigrams\Controller

View source

class OrganigramsController extends ControllerBase {

  /**
   * The Taxonomy Tree builder.
   *
   * @var \Drupal\organigrams\TaxonomyTermTree
   */
  protected $taxonomyTermTree;

  /**
   * Constructs a OrganigramsController object.
   *
   * @param \Drupal\organigrams\TaxonomyTermTree $taxonomyTermTree
   *   The Taxonomy Tree builder.
   */
  public function __construct(TaxonomyTermTree $taxonomyTermTree) {
    $this->taxonomyTermTree = $taxonomyTermTree;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('organigrams.taxonomy_term_tree'));
  }

  /**
   * Returns a form to add a new vocabulary.
   *
   * @return array
   *   The vocabulary add form.
   */
  public function addForm() {
    $term = $this
      ->entityTypeManager()
      ->getStorage('taxonomy_vocabulary')
      ->create();
    return $this
      ->entityFormBuilder()
      ->getForm($term);
  }

  /**
   * Returns a form to add a new term to a vocabulary.
   *
   * @param \Drupal\taxonomy\VocabularyInterface $taxonomy_vocabulary
   *   The vocabulary this term will be added to.
   *
   * @return array
   *   The organigram as a render array.
   */
  public function viewOrganigram(VocabularyInterface $taxonomy_vocabulary) {
    $output = [];

    // Check for permission.
    if (!$this
      ->currentUser()
      ->hasPermission('view organigrams')) {
      return $output;
    }

    // Use our own service to get the hierarchical overview of taxonomy terms
    // in this vocabulary.
    $output = $this->taxonomyTermTree
      ->loadList($taxonomy_vocabulary
      ->id());

    // Include the organigram css.
    $output['#attached']['library'][] = 'organigrams/organigrams';
    return $output;
  }

  /**
   * Outputs the items of an organigram in JSON.
   *
   * @param \Drupal\taxonomy\VocabularyInterface $taxonomy_vocabulary
   *   The vocabulary to export the items from.
   *
   * @return array
   *   A render array.
   */
  public function exportOrganigramItems(VocabularyInterface $taxonomy_vocabulary) {

    // Get all terms in this vocabulary.
    $terms = $this
      ->entityTypeManager()
      ->getStorage('taxonomy_term')
      ->loadTree($taxonomy_vocabulary
      ->id(), 0, NULL, TRUE);

    // Setup array for export data.
    $export_data = [];

    // Check if there are terms.
    if (!empty($terms)) {

      // Ignore these term fields.
      $ignore_fields = [
        'uuid',
        'revision_id',
        'langcode',
        'vid',
        'revision_created',
        'revision_user',
        'revision_log_message',
        'changed',
        'default_langcode',
        'revision_default',
        'revision_translation_affected',
      ];

      // Iterate through the terms.
      foreach ($terms as $term) {

        // Get field definitions.
        $fields = $term
          ->getFieldDefinitions();

        // Create array for the term data.
        $term_data = [];

        // Iterate through the fields.
        foreach ($fields as $field_name => $field) {

          // Continue if the field is in the ignore array.
          if (in_array($field_name, $ignore_fields)) {
            continue;
          }

          // Process the fields.
          switch ($field_name) {
            case 'tid':

              // Export tid as iid so the import works with D7 and D8 exports.
              $term_data['iid'] = $term
                ->get($field_name)->value;
              break;
            case 'parent':

              // The parent needs to be retrieved in a different way.
              $term_data['parent'] = $term->parent->target_id;
              break;
            default:

              // Remove field_o_ from the field name and store it with it's
              // value in the term_data array.
              $term_data[str_replace('field_o_', '', $field_name)] = $term
                ->get($field_name)->value;
          }
        }

        // Add the term data to the export array.
        $export_data[] = $term_data;
      }
    }

    // Textarea for the Json encoded organigram items.
    $form['organigrams_items_json'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Organigram items JSON'),
      '#description' => '',
      '#value' => Json::encode($export_data),
      '#rows' => 20,
    ];
    return $form;
  }

  /**
   * Checks if a vocabulary contains organigrams settings.
   *
   * @param \Drupal\taxonomy\VocabularyInterface $taxonomy_vocabulary
   *   The vocabulary to perform the access check on.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function isOrganigram(VocabularyInterface $taxonomy_vocabulary) {
    if (!empty($taxonomy_vocabulary
      ->getThirdPartySettings('organigrams'))) {
      return AccessResult::allowed();
    }
    return AccessResult::forbidden();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrganigramsController::$taxonomyTermTree	protected	property	The Taxonomy Tree builder.
OrganigramsController::addForm	public	function	Returns a form to add a new vocabulary.
OrganigramsController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
OrganigramsController::exportOrganigramItems	public	function	Outputs the items of an organigram in JSON.
OrganigramsController::isOrganigram	public	function	Checks if a vocabulary contains organigrams settings.
OrganigramsController::viewOrganigram	public	function	Returns a form to add a new term to a vocabulary.
OrganigramsController::__construct	public	function	Constructs a OrganigramsController object.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class OrganigramsController in Organigrams 8.2

Hierarchy

File

Namespace

Members

API Navigation