Factory.php

<?php

namespace ILIAS\UI\Component\Layout\Page;

use ILIAS\UI\Component\MainControls;
use ILIAS\UI\Component\Image\Image;
use ILIAS\UI\Component\Breadcrumbs\Breadcrumbs;

/**
 * This is what a factory for pages looks like.
 */
interface Factory
{
    /**
     * ---
     * description:
     *   purpose: >
     *     The Standard Page is the regular view upon ILIAS.
     *   composition: >
     *     The main parts of a Page are the Metabar, the Mainbar providing
     *     main navigation, the logo, title, breadcrumbs and, of course, the pages's
     *     content. "Content" in this case is the part of the page that is
     *     not Mainbar, Metabar, Footer or Locator, but e.g. the Repository-Listing,
     *     an object's view or edit form, etc.
     *     The locator (in form of breadcrumbs), the logo and titles are optional.
     *     Finally, there are short- and view title. The short title is usually used
     *     to identify the installation of ILIAS, while the view-title gives a very
     *     short  reference to the current view. Both short title and view title are
     *     put into the title-tag of the page so they show up in the browser's tab.
     * featurewiki:
     *   - Desktop: https://docu.ilias.de/goto_docu_wiki_wpage_4563_1357.html
     *   - Mobile: https://docu.ilias.de/goto_docu_wiki_wpage_5095_1357.html
     * rules:
     *   usage:
     *     1: The Standard Page MUST be rendered with content, i.e. the actual view on the context.
     *     2: The Standard Page MUST be rendered with a Metabar.
     *     3: The Standard Page MUST be rendered with a Mainbar.
     *     4: The Standard Page SHOULD be rendered with Breadcrumbs.
     *     5: The Standard Page SHOULD be rendered with a Logo.
     *     6: The Standard Page SHOULD be rendered with a Title.
     *     7: The Standard Page's short title SHOULD reference the current ILIAS installation.
     *     8: The Standard Page's view title SHOULD give a good hint to the current view.
     *   accessibility:
     *     1: >
     *        Scrollable areas of the Standard Page MUST be scrollable by only using
     *        the keyboard.
     *     2: The content area of the Standard Page MUST be focused on page load.
     *     3: >
     *        For the content area of the Standard Page, the HTML tag < main > MUST be used
     *        to be identified as the ARIA Landmark Role "Main".
     *     4: >
     *        For the Header of the Standard Page, where Logo and Title are placed, the HTML tag
     *        < header > MUST be used to be identified as the ARIA Landmark Role "Banner".
     *     5: >
     *        For the Footer of the Standard Page, the HTML tag < footer > MUST be used
     *        to be identified as the ARIA Landmark Role "Contentinfo". As long as
     *        the Footer is nested in the HTML element "main", the HTML element of the
     *        Footer MUST additionally be declared with the ARIA role "Contentinfo".
     * ----
     * @param \ILIAS\UI\Component\Component[]             $content
     * @param \ILIAS\UI\Component\MainControls\Metabar    $metabar
     * @param \ILIAS\UI\Component\MainControls\Mainbar    $mainbar
     * @param \ILIAS\UI\Component\Breadcrumbs\Breadcrumbs $locator
     * @param \ILIAS\UI\Component\Image\Image             $logo
     * @param \ILIAS\UI\Component\MainControls\Footer     $footer
     * @return \ILIAS\UI\Component\Layout\Page\Standard
     */
    public function standard(
        array $content,
        MainControls\MetaBar $metabar = null,
        MainControls\MainBar $mainbar = null,
        Breadcrumbs $locator = null,
        Image $logo = null,
        MainControls\Footer $footer = null,
        string $title = '',
        string $short_title = '',
        string $view_title = ''
    ) : Standard;
}