class RectorResultController in Upgrade Rector 8

Hierarchy

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

Expanded class hierarchy of RectorResultController

File

src/Controller/RectorResultController.php, line 12

Namespace

View source

class RectorResultController extends ControllerBase {

  /**
   * The project collector service.
   *
   * @var \Drupal\upgrade_rector\ProjectCollector
   */
  protected $projectCollector;

  /**
   * Rector result storage.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  protected $rectorResults;

  /**
   * Rector data processor.
   *
   * @var \Drupal\upgrade_rector\RectorProcessor
   */
  protected $rectorProcessor;

  /**
   * Constructs a \Drupal\upgrade_rector\Controller\RectorResultController.
   *
   * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
   *   The key/value factory.
   * @param \Drupal\upgrade_rector\RectorProcessor $rector_processor
   *   The rector processor.
   * @param \Drupal\upgrade_rector\ProjectCollector $project_collector
   *   The project collector service.
   */
  public function __construct(KeyValueFactoryInterface $key_value_factory, RectorProcessor $rector_processor, ProjectCollector $project_collector) {
    $this->rectorResults = $key_value_factory
      ->get('upgrade_status_rector_results');
    $this->rectorProcessor = $rector_processor;
    $this->projectCollector = $project_collector;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('keyvalue'), $container
      ->get('upgrade_rector.rector_processor'), $container
      ->get('upgrade_rector.project_collector'));
  }

  /**
   * Builds content for patch review page/popup.
   *
   * @param string $type
   *   Type of the extension, it can be either 'module' or 'theme' or 'profile'.
   * @param string $project_machine_name
   *   The machine name of the project.
   *
   * @return array
   *   Build array.
   */
  public function resultPage(string $type, string $project_machine_name) {
    $extension = $this->projectCollector
      ->loadProject($type, $project_machine_name);

    // Extensions that don't have a project should be considered custom.
    // Extensions that have the 'drupal' project are custom extensions
    // that are running in a Drupal core git checkout, so also categorize
    // them as custom.
    $category = empty($extension->info['project']) || $extension->info['project'] === 'drupal' ? 'custom' : 'contrib';
    $raw_rector_result = $this->rectorResults
      ->get($project_machine_name);
    return $this->rectorProcessor
      ->formatResults($raw_rector_result, $extension, $category);
  }

  /**
   * Generates single project export.
   *
   * @param string $type
   *   Type of the extension, it can be either 'module' or 'theme' or 'profile'.
   * @param string $project_machine_name
   *   The machine name of the project.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Response object.
   */
  public function resultExport(string $type, string $project_machine_name) {
    $extension = $this->projectCollector
      ->loadProject($type, $project_machine_name);
    $raw_rector_result = $this->rectorResults
      ->get($project_machine_name);
    $processed_result = $this->rectorProcessor
      ->processResults($raw_rector_result, $extension);
    if ($processed_result['state'] === 'fail') {
      $extension = '-errors.txt';
      $content = $raw_rector_result;
    }
    elseif ($processed_result['state'] === 'success' && empty($processed_result['patch'])) {
      $extension = '-results.txt';
      $content = 'Nothing to patch in ' . $project_machine_name;
    }
    else {
      $extension = '-upgrade-rector.patch';
      $content = $processed_result['patch'];
    }
    $filename = $project_machine_name . $extension;
    $response = new Response($content);
    $response->headers
      ->set('Content-Disposition', 'attachment; filename="' . $filename . '"');
    return $response;
  }

}

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.
RectorResultController::$projectCollector	protected	property	The project collector service.
RectorResultController::$rectorProcessor	protected	property	Rector data processor.
RectorResultController::$rectorResults	protected	property	Rector result storage.
RectorResultController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
RectorResultController::resultExport	public	function	Generates single project export.
RectorResultController::resultPage	public	function	Builds content for patch review page/popup.
RectorResultController::__construct	public	function	Constructs a \Drupal\upgrade_rector\Controller\RectorResultController.
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 RectorResultController in Upgrade Rector 8

Hierarchy

File

Namespace

Members

API Navigation