ExpenseController.php in Drupal PM (Project Management) 4.x

Namespace

Drupal\pm_expense\Controller

File

modules/pm_expense/src/Controller/ExpenseController.php

<?php

namespace Drupal\pm_expense\Controller;

use Drupal\Core\Link;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Url;
use Drupal\pm_expense\Entity\ExpenseInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class ExpenseController.
 *
 *  Returns responses for Expense routes.
 */
class ExpenseController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The date formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->dateFormatter = $container
      ->get('date.formatter');
    $instance->renderer = $container
      ->get('renderer');
    return $instance;
  }

  /**
   * Displays a Expense revision.
   *
   * @param int $pm_expense_revision
   *   The Expense revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionShow($pm_expense_revision) {
    $pm_expense = $this
      ->entityTypeManager()
      ->getStorage('pm_expense')
      ->loadRevision($pm_expense_revision);
    $view_builder = $this
      ->entityTypeManager()
      ->getViewBuilder('pm_expense');
    return $view_builder
      ->view($pm_expense);
  }

  /**
   * Page title callback for a Expense revision.
   *
   * @param int $pm_expense_revision
   *   The Expense revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionPageTitle($pm_expense_revision) {
    $pm_expense = $this
      ->entityTypeManager()
      ->getStorage('pm_expense')
      ->loadRevision($pm_expense_revision);
    return $this
      ->t('Revision of %title from %date', [
      '%title' => $pm_expense
        ->label(),
      '%date' => $this->dateFormatter
        ->format($pm_expense
        ->getRevisionCreationTime()),
    ]);
  }

  /**
   * Generates an overview table of older revisions of a Expense.
   *
   * @param \Drupal\pm_expense\Entity\ExpenseInterface $pm_expense
   *   A Expense object.
   *
   * @return array
   *   An array as expected by drupal_render().
   */
  public function revisionOverview(ExpenseInterface $pm_expense) {
    $account = $this
      ->currentUser();
    $pm_expense_storage = $this
      ->entityTypeManager()
      ->getStorage('pm_expense');
    $build['#title'] = $this
      ->t('Revisions for %title', [
      '%title' => $pm_expense
        ->label(),
    ]);
    $header = [
      $this
        ->t('Revision'),
      $this
        ->t('Operations'),
    ];
    $revert_permission = $account
      ->hasPermission("revert all expense revisions") || $account
      ->hasPermission('administer expense entities');
    $delete_permission = $account
      ->hasPermission("delete all expense revisions") || $account
      ->hasPermission('administer expense entities');
    $rows = [];
    $vids = $pm_expense_storage
      ->revisionIds($pm_expense);
    $latest_revision = TRUE;
    foreach (array_reverse($vids) as $vid) {

      /** @var \Drupal\pm_expense\ExpenseInterface $revision */
      $revision = $pm_expense_storage
        ->loadRevision($vid);
      $username = [
        '#theme' => 'username',
        '#account' => $revision
          ->getRevisionUser(),
      ];

      // Use revision link to link to revisions that are not active.
      $date = $this->dateFormatter
        ->format($revision
        ->getRevisionCreationTime(), 'short');
      if ($vid != $pm_expense
        ->getRevisionId()) {
        $link = Link::fromTextAndUrl($date, new Url('entity.pm_expense.revision', [
          'pm_expense' => $pm_expense
            ->id(),
          'pm_expense_revision' => $vid,
        ]));
      }
      else {
        $link = $pm_expense
          ->toLink()
          ->toString($date);
      }
      $row = [];
      $column = [
        'data' => [
          '#type' => 'inline_template',
          '#template' => '{% trans %}{{ date }} by {{ username }}{% endtrans %}{% if message %}<p class="revision-log">{{ message }}</p>{% endif %}',
          '#context' => [
            'date' => $link,
            'username' => $this->renderer
              ->renderPlain($username),
            'message' => [
              '#markup' => $revision
                ->getRevisionLogMessage(),
              '#allowed_tags' => Xss::getHtmlTagList(),
            ],
          ],
        ],
      ];
      $row[] = $column;
      if ($latest_revision) {
        $row[] = [
          'data' => [
            '#prefix' => '<em>',
            '#markup' => $this
              ->t('Current revision'),
            '#suffix' => '</em>',
          ],
        ];
        foreach ($row as &$current) {
          $current['class'] = [
            'revision-current',
          ];
        }
        $latest_revision = FALSE;
      }
      else {
        $links = [];
        if ($revert_permission) {
          $links['revert'] = [
            'title' => $this
              ->t('Revert'),
            'url' => Url::fromRoute('entity.pm_expense.revision_revert', [
              'pm_expense' => $pm_expense
                ->id(),
              'pm_expense_revision' => $vid,
            ]),
          ];
        }
        if ($delete_permission) {
          $links['delete'] = [
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute('entity.pm_expense.revision_delete', [
              'pm_expense' => $pm_expense
                ->id(),
              'pm_expense_revision' => $vid,
            ]),
          ];
        }
        $row[] = [
          'data' => [
            '#type' => 'operations',
            '#links' => $links,
          ],
        ];
      }
      $rows[] = $row;
    }
    $build['pm_expense_revisions_table'] = [
      '#theme' => 'table',
      '#rows' => $rows,
      '#header' => $header,
    ];
    return $build;
  }

}

Classes

Name	Description
ExpenseController	Class ExpenseController.