You are here

Home » API reference » Hacked! 8.2 » HackedDiffController.php

class HackedDiffController in Hacked! 8.2

Controller routines for hacked routes.

Hierarchy

Expanded class hierarchy of HackedDiffController

File

src/Controller/HackedDiffController.php, line 14

Namespace

Drupal\hacked\Controller
View source 
class HackedDiffController extends ControllerBase {

  /**
   * Wrapper object for writing/reading configuration from diff.plugins.yml
   */
  protected $config;

  /**
   * The diff entity comparison service.
   */
  protected $entityComparison;

  /**
   * Constructs a HackedDiffController object.
   *
   * @param DiffEntityComparison $entity_comparison
   *   DiffEntityComparison service.
   */
  public function __construct(DiffEntityComparison $entity_comparison) {
    $this->config = $this
      ->config('diff.settings');
    $this->entityComparison = $entity_comparison;
  }

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

  /**
   * Shows a diff report for a specific file in a project.
   *
   * @param                              $project
   *   The hackedProject instance.
   *
   * @param \Drupal\hacked\hackedProject $project
   * @return array
   */
  public function hackedProjectDiff(hackedProject $project) {
    if (!\Drupal::moduleHandler()
      ->moduleExists('diff')) {
      return [
        '#markup' => $this
          ->t('The diff module is required to use this feature.'),
      ];
    }
    $file = \Drupal::request()
      ->get('file');
    $project
      ->identify_project();

    // Find a better way to do this:
    //    $breadcrumb = array(
    //      l('Home', '<front>'),
    //      l('Administer', 'admin'),
    //      l('Reports', 'admin/reports'),
    //      l('Hacked', 'admin/reports/hacked'),
    //      l($project->title(), 'admin/reports/hacked/' . $project->name),
    //    );
    //    drupal_set_breadcrumb($breadcrumb);
    if ($project
      ->file_is_diffable($file)) {
      $original_file = $project
        ->file_get_location('remote', $file);
      $installed_file = $project
        ->file_get_location('local', $file);

      /** @var hackedFileHasher $hasher */
      $hasher = hacked_get_file_hasher();
      $build = [
        '#theme' => 'table',
        '#header' => [
          t('Original'),
          '',
          t('Current'),
          '',
        ],
        '#rows' => $this->entityComparison
          ->getRows($hasher
          ->fetch_lines($original_file), $hasher
          ->fetch_lines($installed_file), TRUE),
      ];

      // Add the CSS for the diff.
      $build['#attached']['library'][] = 'diff/diff.general';
      $theme = $this->config
        ->get('general_settings.theme');
      if ($theme) {
        if ($theme == 'default') {
          $build['#attached']['library'][] = 'diff/diff.default';
        }
        elseif ($theme == 'github') {
          $build['#attached']['library'][] = 'diff/diff.github';
        }
      }
      elseif ($theme == NULL) {
        $build['#attached']['library'][] = 'diff/diff.github';
      }
      return $build;
    }
    return [
      '#markup' => $this
        ->t('Cannot hash binary file or file not found: %file', array(
        '%file' => $file,
      )),
    ];
  }

  /**
   * Menu title callback for the hacked site report page.
   */
  public function hackedProjectDiffTitle(hackedProject $project) {
    $file = \Drupal::request()
      ->get('file');
    return $this
      ->t('Hacked status for @file in project @project', [
      '@project' => $project
        ->title(),
      '@file' => $file,
    ]);
  }

}

Members

Namesort descending 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.
HackedDiffController::$config protected property Wrapper object for writing/reading configuration from diff.plugins.yml
HackedDiffController::$entityComparison protected property The diff entity comparison service.
HackedDiffController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
HackedDiffController::hackedProjectDiff public function Shows a diff report for a specific file in a project.
HackedDiffController::hackedProjectDiffTitle public function Menu title callback for the hacked site report page.
HackedDiffController::__construct public function Constructs a HackedDiffController object.
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.
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.