class HistoryController

Same name in other branches
  1. 9 core/modules/history/src/Controller/HistoryController.php \Drupal\history\Controller\HistoryController
  2. 10 core/modules/history/src/Controller/HistoryController.php \Drupal\history\Controller\HistoryController
  3. 11.x core/modules/history/src/Controller/HistoryController.php \Drupal\history\Controller\HistoryController

Returns responses for History module routes.

Hierarchy

Expanded class hierarchy of HistoryController

File

core/modules/history/src/Controller/HistoryController.php, line 15

Namespace

Drupal\history\Controller
View source
class HistoryController extends ControllerBase {
    
    /**
     * Returns a set of nodes' last read timestamps.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request of the page.
     *
     * @return Symfony\Component\HttpFoundation\JsonResponse
     *   The JSON response.
     */
    public function getNodeReadTimestamps(Request $request) {
        if ($this->currentUser()
            ->isAnonymous()) {
            throw new AccessDeniedHttpException();
        }
        $nids = $request->request
            ->get('node_ids');
        if (!isset($nids)) {
            throw new NotFoundHttpException();
        }
        return new JsonResponse(history_read_multiple($nids));
    }
    
    /**
     * Marks a node as read by the current user right now.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request of the page.
     * @param \Drupal\node\NodeInterface $node
     *   The node whose "last read" timestamp should be updated.
     */
    public function readNode(Request $request, NodeInterface $node) {
        if ($this->currentUser()
            ->isAnonymous()) {
            throw new AccessDeniedHttpException();
        }
        // Update the history table, stating that this user viewed this node.
        history_write($node->id());
        return new JsonResponse((int) history_read($node->id()));
    }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 46
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.
HistoryController::getNodeReadTimestamps public function Returns a set of nodes' last read timestamps.
HistoryController::readNode public function Marks a node as read by the current user right now.
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.
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.