class BookController

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

Controller routines for book routes.

Hierarchy

Expanded class hierarchy of BookController

File

core/modules/book/src/Controller/BookController.php, line 20

Namespace

Drupal\book\Controller
View source
class BookController extends ControllerBase {
    
    /**
     * The book manager.
     *
     * @var \Drupal\book\BookManagerInterface
     */
    protected $bookManager;
    
    /**
     * The book export service.
     *
     * @var \Drupal\book\BookExport
     */
    protected $bookExport;
    
    /**
     * The renderer.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs a BookController object.
     *
     * @param \Drupal\book\BookManagerInterface $bookManager
     *   The book manager.
     * @param \Drupal\book\BookExport $bookExport
     *   The book export service.
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer.
     */
    public function __construct(BookManagerInterface $bookManager, BookExport $bookExport, RendererInterface $renderer) {
        $this->bookManager = $bookManager;
        $this->bookExport = $bookExport;
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('book.manager'), $container->get('book.export'), $container->get('renderer'));
    }
    
    /**
     * Returns an administrative overview of all books.
     *
     * @return array
     *   A render array representing the administrative page content.
     */
    public function adminOverview() {
        $rows = [];
        $headers = [
            t('Book'),
            t('Operations'),
        ];
        // Add any recognized books to the table list.
        foreach ($this->bookManager
            ->getAllBooks() as $book) {
            
            /** @var \Drupal\Core\Url $url */
            $url = $book['url'];
            if (isset($book['options'])) {
                $url->setOptions($book['options']);
            }
            $row = [
                Link::fromTextAndUrl($book['title'], $url),
            ];
            $links = [];
            $links['edit'] = [
                'title' => t('Edit order and titles'),
                'url' => Url::fromRoute('book.admin_edit', [
                    'node' => $book['nid'],
                ]),
            ];
            $row[] = [
                'data' => [
                    '#type' => 'operations',
                    '#links' => $links,
                ],
            ];
            $rows[] = $row;
        }
        return [
            '#type' => 'table',
            '#header' => $headers,
            '#rows' => $rows,
            '#empty' => t('No books available.'),
        ];
    }
    
    /**
     * Prints a listing of all books.
     *
     * @return array
     *   A render array representing the listing of all books content.
     */
    public function bookRender() {
        $book_list = [];
        foreach ($this->bookManager
            ->getAllBooks() as $book) {
            $book_list[] = Link::fromTextAndUrl($book['title'], $book['url']);
        }
        return [
            '#theme' => 'item_list',
            '#items' => $book_list,
            '#cache' => [
                'tags' => $this->entityTypeManager()
                    ->getDefinition('node')
                    ->getListCacheTags(),
            ],
        ];
    }
    
    /**
     * Generates representations of a book page and its children.
     *
     * The method delegates the generation of output to helper methods. The method
     * name is derived by prepending 'bookExport' to the camelized form of given
     * output type. For example, a type of 'html' results in a call to the method
     * bookExportHtml().
     *
     * @param string $type
     *   A string encoding the type of output requested. The following types are
     *   currently supported in book module:
     *   - html: Printer-friendly HTML.
     *   Other types may be supported in contributed modules.
     * @param \Drupal\node\NodeInterface $node
     *   The node to export.
     *
     * @return array
     *   A render array representing the node and its children in the book
     *   hierarchy in a format determined by the $type parameter.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function bookExport($type, NodeInterface $node) {
        $method = 'bookExport' . Container::camelize($type);
        // @todo Convert the custom export functionality to serializer.
        if (!method_exists($this->bookExport, $method)) {
            $this->messenger()
                ->addStatus(t('Unknown export format.'));
            throw new NotFoundHttpException();
        }
        $exported_book = $this->bookExport
            ->{$method}($node);
        return new Response($this->renderer
            ->renderRoot($exported_book));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
BookController::$bookExport protected property The book export service.
BookController::$bookManager protected property The book manager.
BookController::$renderer protected property The renderer.
BookController::adminOverview public function Returns an administrative overview of all books.
BookController::bookExport public function Generates representations of a book page and its children.
BookController::bookRender public function Prints a listing of all books.
BookController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
BookController::__construct public function Constructs a BookController object.
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.
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.