class UpdateController

Same name in other branches
  1. 9 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 12

Namespace

Drupal\update\Controller
View source
class UpdateController extends ControllerBase {
    
    /**
     * Update manager service.
     *
     * @var \Drupal\update\UpdateManagerInterface
     */
    protected $updateManager;
    
    /**
     * Constructs update status data.
     *
     * @param \Drupal\update\UpdateManagerInterface $update_manager
     *   Update Manager Service.
     */
    public function __construct(UpdateManagerInterface $update_manager) {
        $this->updateManager = $update_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('update.manager'));
    }
    
    /**
     * 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);
        }
        return $build;
    }
    
    /**
     * Manually checks the update status without the use of cron.
     */
    public function updateStatusManually() {
        $this->updateManager
            ->refreshUpdateData();
        $batch = [
            'operations' => [
                [
                    [
                        $this->updateManager,
                        'fetchDataBatch',
                    ],
                    [],
                ],
            ],
            'finished' => 'update_fetch_data_finished',
            'title' => t('Checking available update data'),
            'progress_message' => t('Trying to check available update data ...'),
            'error_message' => t('Error checking available update data.'),
        ];
        batch_set($batch);
        return batch_process('admin/reports/updates');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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. 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.
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::$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.
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.

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