class UpdateController

Same name in other branches
  1. 8.9.x core/modules/update/src/Controller/UpdateController.php \Drupal\update\Controller\UpdateController
  2. 10 core/modules/update/src/Controller/UpdateController.php \Drupal\update\Controller\UpdateController
  3. 11.x core/modules/update/src/Controller/UpdateController.php \Drupal\update\Controller\UpdateController

Controller routines for update routes.

Hierarchy

Expanded class hierarchy of UpdateController

File

core/modules/update/src/Controller/UpdateController.php, line 15

Namespace

Drupal\update\Controller
View source
class UpdateController extends ControllerBase {
    
    /**
     * Update manager service.
     *
     * @var \Drupal\update\UpdateManagerInterface
     */
    protected $updateManager;
    
    /**
     * The renderer.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs update status data.
     *
     * @param \Drupal\update\UpdateManagerInterface $update_manager
     *   Update Manager Service.
     * @param \Drupal\Core\Render\RendererInterface|null $renderer
     *   The renderer.
     */
    public function __construct(UpdateManagerInterface $update_manager, RendererInterface $renderer = NULL) {
        $this->updateManager = $update_manager;
        if (is_null($renderer)) {
            @trigger_error('The renderer service should be passed to UpdateController::__construct() since 9.1.0. This will be required in Drupal 10.0.0. See https://www.drupal.org/node/3179315', E_USER_DEPRECATED);
            $renderer = \Drupal::service('renderer');
        }
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('update.manager'), $container->get('renderer'));
    }
    
    /**
     * Returns a page about the update status of projects.
     *
     * @return array
     *   A build array with the update status of projects.
     */
    public function updateStatus() {
        $build = [
            '#theme' => 'update_report',
        ];
        if ($available = update_get_available(TRUE)) {
            $this->moduleHandler()
                ->loadInclude('update', 'compare.inc');
            $build['#data'] = update_calculate_project_data($available);
            // @todo Consider using 'fetch_failures' from the 'update' collection
            // in the key_value_expire service for this?
            $fetch_failed = FALSE;
            foreach ($build['#data'] as $project) {
                if ($project['status'] === UpdateFetcherInterface::NOT_FETCHED) {
                    $fetch_failed = TRUE;
                    break;
                }
            }
            if ($fetch_failed) {
                $message = [
                    '#theme' => 'update_fetch_error_message',
                ];
                $this->messenger()
                    ->addError($this->renderer
                    ->renderPlain($message));
            }
        }
        return $build;
    }
    
    /**
     * Manually checks the update status without the use of cron.
     */
    public function updateStatusManually() {
        $this->updateManager
            ->refreshUpdateData();
        $batch_builder = (new BatchBuilder())->setTitle(t('Checking available update data'))
            ->addOperation([
            $this->updateManager,
            'fetchDataBatch',
        ], [])
            ->setProgressMessage(t('Trying to check available update data ...'))
            ->setErrorMessage(t('Error checking available update data.'))
            ->setFinishCallback('update_fetch_data_finished');
        batch_set($batch_builder->toArray());
        return batch_process('admin/reports/updates');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
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. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
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. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage 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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.
UpdateController::$renderer protected property The renderer.
UpdateController::$updateManager protected property Update manager service.
UpdateController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
UpdateController::updateStatus public function Returns a page about the update status of projects.
UpdateController::updateStatusManually public function Manually checks the update status without the use of cron.
UpdateController::__construct public function Constructs update status data.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.