AdministrationPage::insertBreadcrumbs() - Code Metrics - Inspection of "WIP: Refactor Installation" - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — integration (#2604)

by Brendan
created 2016-06-27 08:37 UTC
AdministrationPage::insertBreadcrumbs() B

↳ Parent: AdministrationPage
Complexity

Conditions	5
Paths	5
Size

Total Lines	24
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	5
eloc	15
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	24
rs	8.5125
<?php

    /**
     * @package toolkit
     */

    /**
     * The AdministrationPage class represents a Symphony backend page.
     * It extends the HTMLPage class and unlike the Frontend, is generated
     * using a number XMLElement objects. Instances of this class override
     * the view, switchboard and action functions to construct the page. These
     * functions act as pseudo MVC, with the switchboard being controller,
     * and the view/action being the view.
     */
    class AdministrationPage extends HTMLPage
    {
        /**
         * An array of `Alert` objects used to display page level
         * messages to Symphony backend users one by one. Prior to Symphony 2.3
         * this variable only held a single `Alert` object.
         *
         * @var array
         */
        public $Alert = array();

        /**
         * As the name suggests, a `<div>` that holds the following `$Header`,
         * `$Contents` and `$Footer`.
         *
         * @var XMLElement
         */
        public $Wrapper = null;

        /**
         * A `<div>` that contains the header of a Symphony backend page, which
         * typically contains the Site title and the navigation.
         *
         * @var XMLElement
         */
        public $Header = null;

        /**
         * A `<div>` that contains the breadcrumbs, the page title and some contextual
         * actions (e.g. "Create new").
         *
         * @since Symphony 2.3
         * @var XMLElement
         */
        public $Context = null;

        /**
         * An object that stores the markup for the breadcrumbs and is only used
         * internally.
         *
         * @since Symphony 2.3
         * @var XMLElement
         */
        public $Breadcrumbs = null;

        /**
         * An array of Drawer widgets for the current page
         *
         * @since Symphony 2.3
         * @var array
         */
        public $Drawer = array();

        /**
         * A `<div>` that contains the content of a Symphony backend page.
         *
         * @var XMLElement
         */
        public $Contents = null;

        /**
         * An associative array of the navigation where the key is the group
         * index, and the value is an associative array of 'name', 'index' and
         * 'children'. Name is the name of the this group, index is the same as
         * the key and children is an associative array of navigation items containing
         * the keys 'link', 'name' and 'visible'. In Symphony, all navigation items
         * are contained within a group, and the group has no 'default' link, therefore
         * it is up to the children to provide the link to pages. This link should be
         * relative to the Symphony path, although it is possible to provide an
         * absolute link by providing a key, 'relative' with the value false.
         *
         * @var array
         */
        public $_navigation = array();

        /**
         *  An associative array describing this pages context. This
         *  can include the section handle, the current entry_id, the page
         *  name and any flags such as 'saved' or 'created'. This variable
         *  often provided in delegates so extensions can manipulate based
         *  off the current context or add new keys.
         *
         * @var array
         */
        public $_context = null;

        /**
         * The class attribute of the `<body>` element for this page. Defaults
         * to an empty string
         *
         * @var string
         */
        private $_body_class = '';

        /**
         * Constructor calls the parent constructor to set up
         * the basic HTML, Head and Body `XMLElement`'s. This function
         * also sets the `XMLElement` element style to be HTML, instead of XML
         */
        public function __construct()
        {
            parent::__construct();

            $this->Html->setElementStyle('html');
        }

        /**
         * Specifies the type of page that being created. This is used to
         * trigger various styling hooks. If your page is mainly a form,
         * pass 'form' as the parameter, if it's displaying a single entry,
         * pass 'single'. If any other parameter is passed, the 'index'
         * styling will be applied.
         *
         * @param string $type
         *  Accepts 'form' or 'single', any other `$type` will trigger 'index'
         *  styling.
         */
        public function setPageType($type = 'form')
        {
            $this->setBodyClass($type === 'form' || $type === 'page-single' ? 'page-single' : 'page-index');
        }

        /**
         * Setter function to set the class attribute on the `<body>` element.
         * This function will respect any previous classes that have been added
         * to this `<body>`
         *
         * @param string $class
         *  The string of the classname, multiple classes can be specified by
         *  uses a space separator
         */
        public function setBodyClass($class)
        {
            // Prevents duplicate "page-index" classes
            if (!isset($this->_context['page']) || !in_array('page-index', array($this->_context['page'], $class))) {
                $this->_body_class .= $class;
            }

            $this->Body->setAttribute('class', $this->_body_class);
        }

        /**
         * Given the current page `$context` and the URL path parts, parse the context for
         * the current page. This happens prior to the AdminPagePostCallback delegate
         * being fired. The `$context` is passed by reference
         *
         * @since Symphony 3.0.0
         * @param array $context
         * @param array $parts
         * @return void
         */
        public function parseContext(array &$context, array $parts)
        {
        }

        /**
         * Accessor for `$this->_context` which includes contextual information
         * about the current page such as the class, file location or page root.
         * This information varies depending on if the page is provided by an
         * extension, is for the publish area, is the login page or any other page
         *
         * @since Symphony 2.3
         * @return array
         */
        public function getContext()
        {
            return $this->_context;
        }

        /**
         * Given a `$message` and an optional `$type`, this function will
         * add an Alert instance into this page's `$this->Alert` property.
         * Since Symphony 2.3, there may be more than one `Alert` per page.
         * Unless the Alert is an Error, it is required the `$message` be
         * passed to this function.
         *
         * @param string $message
         *  The message to display to users
         * @param string $type
         *  An Alert constant, being `Alert::NOTICE`, `Alert::ERROR` or
         *  `Alert::SUCCESS`. The differing types will show the error
         *  in a different style in the backend. If omitted, this defaults
         *  to `Alert::NOTICE`.
         * @throws Exception
         */
        public function pageAlert($message = null, $type = Alert::NOTICE)
        {
            if (is_null($message) && $type === Alert::ERROR) {
                $message = __('There was a problem rendering this page. Please check the activity log for more details.');
            } else {
                $message = __($message);
            }

            if (strlen(trim($message)) === 0) {
                throw new Exception(__('A message must be supplied unless the alert is of type Alert::ERROR'));
            }

            $this->Alert[] = new Alert($message, $type);
        }

        /**
         * Appends the heading of this Symphony page to the Context element.
         * Action buttons can be provided (e.g. "Create new") as second parameter.
         *
         * @since Symphony 2.3
         * @param string $value
         *  The heading text
         * @param array|XMLElement|string $actions
         *  Some contextual actions to append to the heading, they can be provided as
         *  an array of XMLElements or strings. Traditionally Symphony uses this to append
         *  a "Create new" link to the Context div.
         */
        public function appendSubheading($value, $actions = null)
        {
            if (!is_array($actions) && $actions) { // Backward compatibility
                $actions = array($actions);
            }

            if (!empty($actions)) {
                foreach ($actions as $a) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                    $this->insertAction($a);
                }
            }

            $this->Breadcrumbs->appendChild(new XMLElement('h2', $value,
                array('role' => 'heading', 'id' => 'symphony-subheading')));
        }

        /**
         * This function allows a user to insert an Action button to the page.
         * It accepts an `XMLElement` (which should be of the `Anchor` type),
         * an optional parameter `$prepend`, which when `true` will add this
         * action before any existing actions.
         *
         * @since Symphony 2.3
         * @see core.Widget#Anchor
         * @param XMLElement $action
         *  An Anchor element to add to the top of the page.
         * @param boolean $append
         *  If true, this will add the `$action` after existing actions, otherwise
         *  it will be added before existing actions. By default this is `true`,
         *  which will add the `$action` after current actions.
         */
        public function insertAction(XMLElement $action, $append = true)
        {
            $actions = $this->Context->getChildrenByName('ul');

            // Actions haven't be added yet, create the element
            if (empty($actions)) {
                $ul = new XMLElement('ul', null, array('class' => 'actions'));
                $this->Context->appendChild($ul);
            } else {
                $ul = current($actions);
                $this->Context->replaceChildAt(1, $ul);
            }

            $li = new XMLElement('li', $action);

            if ($append) {
                $ul->prependChild($li);
            } else {
                $ul->appendChild($li);
            }
        }

        /**
         * Allows developers to specify a list of nav items that build the
         * path to the current page or, in jargon, "breadcrumbs".
         *
         * @since Symphony 2.3
         * @param array $values
         *  An array of `XMLElement`'s or strings that compose the path. If breadcrumbs
         *  already exist, any new item will be appended to the rightmost part of the
         *  path.
         */
        public function insertBreadcrumbs(array $values)
        {
            if (empty($values)) {
                return;
            }

            if ($this->Breadcrumbs instanceof XMLElement && count($this->Breadcrumbs->getChildrenByName('nav')) === 1) {
                $nav = $this->Breadcrumbs->getChildrenByName('nav');
                $nav = $nav[0];

                $p = $nav->getChild(0);
            } else {
                $p = new XMLElement('p');
                $nav = new XMLElement('nav');
                $nav->appendChild($p);

                $this->Breadcrumbs->prependChild($nav);
            }

            foreach ($values as $v) {
                $p->appendChild($v);
                $p->appendChild(new XMLElement('span', '&#8250;', array('class' => 'sep')));
            }
        }

        /**
         * Allows a Drawer element to added to the backend page in one of three
         * positions, `horizontal`, `vertical-left` or `vertical-right`. The button
         * to trigger the visibility of the drawer will be added after existing
         * actions by default.
         *
         * @since Symphony 2.3
         * @see core.Widget#Drawer
         * @param XMLElement $drawer
         *  An XMLElement representing the drawer, use `Widget::Drawer` to construct
         * @param string $position
         *  Where `$position` can be `horizontal`, `vertical-left` or
         *  `vertical-right`. Defaults to `horizontal`.
         * @param string $button
         *  If not passed, a button to open/close the drawer will not be added
         *  to the interface. Accepts 'prepend' or 'append' values, which will
         *  add the button before or after existing buttons. Defaults to `prepend`.
         *  If any other value is passed, no button will be added.
         * @throws InvalidArgumentException
         */
        public function insertDrawer(XMLElement $drawer, $position = 'horizontal', $button = 'append')
        {
            $drawer->addClass($position);
            $drawer->setAttribute('data-position', $position);
            $drawer->setAttribute('role', 'complementary');
            $this->Drawer[$position][] = $drawer;

            if (in_array($button, array('prepend', 'append'))) {
                $this->insertAction(
                    Widget::Anchor(
                        $drawer->getAttribute('data-label'),
                        '#' . $drawer->getAttribute('id'),
                        null,
                        'button drawer ' . $position
                    ),
                    ($button === 'append' ? true : false)
                );
            }
        }

        /**
         * This function initialises a lot of the basic elements that make up a Symphony
         * backend page such as the default stylesheets and scripts, the navigation and
         * the footer. Any alerts are also appended by this function. `view()` is called to
         * build the actual content of the page. The `InitialiseAdminPageHead` delegate
         * allows extensions to add elements to the `<head>`.
         *
         * @see  view()
         * @uses InitialiseAdminPageHead
         * @param array $context
         *  An associative array describing this pages context. This
         *  can include the section handle, the current entry_id, the page
         *  name and any flags such as 'saved' or 'created'. This list is not exhaustive
         *  and extensions can add their own keys to the array.
         * @throws InvalidArgumentException
         * @throws SymphonyErrorPage
         */
        public function build(array $context = array())
        {
            $this->_context = $context;

            if (!$this->canAccessPage()) {
                Administration::instance()->throwCustomError(
                    __('You are not authorised to access this page.'),
                    __('Access Denied'),
                    Page::HTTP_STATUS_UNAUTHORIZED
                );
            }

            $this->Html->setDTD('<!DOCTYPE html>');
            $this->Html->setAttribute('lang', Lang::get());
            $this->addElementToHead(new XMLElement('meta', null, array('charset' => 'UTF-8')), 0);
            $this->addElementToHead(new XMLElement('meta', null,
                array('http-equiv' => 'X-UA-Compatible', 'content' => 'IE=edge,chrome=1')), 1);
            $this->addElementToHead(new XMLElement('meta', null,
                array('name' => 'viewport', 'content' => 'width=device-width, initial-scale=1')), 2);

            // Add styles
            $this->addStylesheetToHead(ASSETS_URL . '/css/symphony.min.css', 'screen', 2, false);

            // Calculate timezone offset from UTC
            $timezone = new DateTimeZone(Symphony::Configuration()->get('timezone', 'region'));
            $datetime = new DateTime('now', $timezone);
            $timezoneOffset = intval($timezone->getOffset($datetime)) / 60;

            // Add scripts
            $environment = array(

                'root' => URL,
                'symphony' => SYMPHONY_URL,
                'path' => '/' . Symphony::Configuration()->get('admin-path', 'symphony'),
                'route' => getCurrentPage(),
                'version' => Symphony::Configuration()->get('version', 'symphony'),
                'lang' => Lang::get(),
                'user' => array(

                    'fullname' => Symphony::Author()->getFullName(),
                    'name' => Symphony::Author()->get('first_name'),
                    'type' => Symphony::Author()->get('user_type'),
                    'id' => Symphony::Author()->get('id')
                ),
                'datetime' => array(

                    'formats' => DateTimeObj::getDateFormatMappings(),
                    'timezone-offset' => $timezoneOffset
                ),
                'env' => array_merge(

                    array('page-namespace' => Symphony::getPageNamespace()),
                    $this->_context
                )
            );

            $this->addElementToHead(
                new XMLElement('script', json_encode($environment), array(
                    'type' => 'application/json',
                    'id' => 'environment'
                )),
                4
            );

            $this->addScriptToHead(ASSETS_URL . '/js/symphony.min.js', 6, false);

            // Initialise page containers
            $this->Wrapper = new XMLElement('div', null, array('id' => 'wrapper'));
            $this->Header = new XMLElement('header', null, array('id' => 'header'));
            $this->Context = new XMLElement('div', null, array('id' => 'context'));
            $this->Breadcrumbs = new XMLElement('div', null, array('id' => 'breadcrumbs'));
            $this->Contents = new XMLElement('div', null, array('id' => 'contents', 'role' => 'main'));
            $this->Form = Widget::Form(Administration::instance()->getCurrentPageURL(), 'post', null, null,
                array('role' => 'form'));

            /**
             * Allows developers to insert items into the page HEAD. Use
             * `Administration::instance()->Page` for access to the page object.
             *
             * @since In Symphony 2.3.2 this delegate was renamed from
             *  `InitaliseAdminPageHead` to the correct spelling of
             *  `InitialiseAdminPageHead`. The old delegate is supported
             *  until Symphony 3.0.0
             *
             * @delegate InitialiseAdminPageHead
             * @param string $context
             *  '/backend/'
             */
            Symphony::ExtensionManager()->notifyMembers('InitialiseAdminPageHead', '/backend/');
            Symphony::ExtensionManager()->notifyMembers('InitaliseAdminPageHead', '/backend/');

            $this->addHeaderToPage('Content-Type', 'text/html; charset=UTF-8');
            $this->addHeaderToPage('Cache-Control', 'no-cache, must-revalidate, max-age=0');
            $this->addHeaderToPage('Last-Modified', gmdate('D, d M Y H:i:s') . ' GMT');

            // If not set by another extension, lock down the backend
            if (!array_key_exists('x-frame-options', $this->headers())) {
                $this->addHeaderToPage('X-Frame-Options', 'SAMEORIGIN');
            }

            if (!array_key_exists('access-control-allow-origin', $this->headers())) {
                $this->addHeaderToPage('Access-Control-Allow-Origin', URL);
            }

            if (isset($_REQUEST['action'])) {
                $this->action();
                Symphony::Profiler()->sample('Page action run', PROFILE_LAP);
            }

            $h1 = new XMLElement('h1');
            $h1->appendChild(Widget::Anchor(Symphony::Configuration()->get('sitename', 'general'),
                rtrim(URL, '/') . '/'));
            $this->Header->appendChild($h1);

            $this->appendUserLinks();
            $this->appendNavigation();

            // Add Breadcrumbs
            $this->Context->prependChild($this->Breadcrumbs);
            $this->Contents->appendChild($this->Form);

            $this->view();

            $this->appendAlert();

            Symphony::Profiler()->sample('Page content created', PROFILE_LAP);
        }

        /**
         * Checks the current Symphony Author can access the current page.
         * This check uses the `ASSETS . /xml/navigation.xml` file to determine
         * if the current page (or the current page namespace) can be viewed
         * by the currently logged in Author.
         *
         * @link http://github.com/symphonycms/symphony-2/blob/master/symphony/assets/xml/navigation.xml
         * @return boolean
         *  True if the Author can access the current page, false otherwise
         */
        public function canAccessPage()
        {
            $nav = $this->getNavigationArray();
            $page = '/' . trim(getCurrentPage(), '/') . '/';

            $page_limit = 'author';

            foreach ($nav as $item) {
                if (
                    // If page directly matches one of the children
                    General::in_array_multi($page, $item['children'])
                    // If the page namespace matches one of the children (this will usually drop query
                    // string parameters such as /edit/1/)
                    || General::in_array_multi(Symphony::getPageNamespace() . '/', $item['children'])
                ) {
                    if (is_array($item['children'])) {
                        foreach ($item['children'] as $c) {
                            if ($c['link'] === $page && isset($c['limit'])) {
                                $page_limit = $c['limit'];
                            }
                        }
                    }

                    if (isset($item['limit']) && $page_limit !== 'primary') {
                        if ($page_limit === 'author' && $item['limit'] === 'developer') {
                            $page_limit = 'developer';
                        }
                    }
                } elseif (isset($item['link']) && $page === $item['link'] && isset($item['limit'])) {
                    $page_limit = $item['limit'];
                }
            }

            return $this->doesAuthorHaveAccess($page_limit);
        }

        /**
         * Returns the `$_navigation` variable of this Page. If it is empty,
         * it will be built by `__buildNavigation`
         *
         * @see __buildNavigation()
         * @return array
         */
        public function getNavigationArray()
        {
            if (empty($this->_navigation)) {
                $this->__buildNavigation();
            }

            return $this->_navigation;
        }

        /**
         * This function populates the `$_navigation` array with an associative array
         * of all the navigation groups and their links. Symphony only supports one
         * level of navigation, so children links cannot have children links. The default
         * Symphony navigation is found in the `ASSETS/xml/navigation.xml` folder. This is
         * loaded first, and then the Section navigation is built, followed by the Extension
         * navigation. Additionally, this function will set the active group of the navigation
         * by checking the current page against the array of links.
         *
         * @link https://github.com/symphonycms/symphony-2/blob/master/symphony/assets/xml/navigation.xml
         * @link https://github.com/symphonycms/symphony-2/blob/master/symphony/lib/toolkit/class.extension.php
         */
        public function __buildNavigation()
        {
            $nav = array();

            $this->buildXmlNavigation($nav);
            $this->buildSectionNavigation($nav);
            $this->buildExtensionsNavigation($nav);

            $pageCallback = Administration::instance()->getPageCallback();

            $pageRoot = $pageCallback['pageroot'] . (isset($pageCallback['context'][0]) ? $pageCallback['context'][0] . '/' : '');
            $found = self::__findActiveNavigationGroup($nav, $pageRoot);

            // Normal searches failed. Use a regular expression using the page root. This is less
            // efficient and should never really get invoked unless something weird is going on
            if (!$found) {
                self::__findActiveNavigationGroup($nav, '/^' . str_replace('/', '\/', $pageCallback['pageroot']) . '/i',
                    true);
            }

            ksort($nav);
            $this->_navigation = $nav;
        }

        /**
         * This method fills the `$nav` array with value
         * from the `ASSETS/xml/navigation.xml` file
         *
         * @link http://github.com/symphonycms/symphony-2/blob/master/symphony/assets/xml/navigation.xml
         *
         * @since Symphony 2.3.2
         *
         * @param array $nav
         *  The navigation array that will receive nav nodes
         */
        private function buildXmlNavigation(&$nav)
        {
            $xml = simplexml_load_file(ASSETS . '/xml/navigation.xml');

            // Loop over the default Symphony navigation file, converting
            // it into an associative array representation
            foreach ($xml->xpath('/navigation/group') as $n) {
                $index = (string)$n->attributes()->index;
                $children = $n->xpath('children/item');
                $content = $n->attributes();

                // If the index is already set, increment the index and check again.
                // Rinse and repeat until the index is not set.
                if (isset($nav[$index])) {
                    do {
                        $index++;
                    } while (isset($nav[$index]));
                }

                $nav[$index] = array(
                    'name' => __(strval($content->name)),
                    'type' => 'structure',
                    'index' => $index,
                    'children' => array()
                );

                if (strlen(trim((string)$content->limit)) > 0) {
                    $nav[$index]['limit'] = (string)$content->limit;
                }

                if (count($children) > 0) {
                    foreach ($children as $child) {
                        $item = array(
                            'link' => (string)$child->attributes()->link,
                            'name' => __(strval($child->attributes()->name)),
                            'visible' => ((string)$child->attributes()->visible === 'no' ? 'no' : 'yes'),
                        );

                        $limit = (string)$child->attributes()->limit;

                        if (strlen(trim($limit)) > 0) {
                            $item['limit'] = $limit;
                        }

                        $nav[$index]['children'][] = $item;
                    }
                }
            }
        }

        /**
         * This method fills the `$nav` array with value
         * from each Section
         *
         * @since Symphony 2.3.2
         *
         * @param array $nav
         *  The navigation array that will receive nav nodes
         */
        private function buildSectionNavigation(&$nav)
        {
            // Build the section navigation, grouped by their navigation groups
            $sections = SectionManager::fetch(null, 'asc', 'sortorder');

            if (is_array($sections) && !empty($sections)) {
                foreach ($sections as $s) {
                    $group_index = self::__navigationFindGroupIndex($nav, $s->get('navigation_group'));

                    if ($group_index === false) {
                        $group_index = General::array_find_available_index($nav, 0);

                        $nav[$group_index] = array(
                            'name' => $s->get('navigation_group'),
                            'type' => 'content',
                            'index' => $group_index,
                            'children' => array()
                        );
                    }

                    $nav[$group_index]['children'][] = array(
                        'link' => '/publish/' . $s->get('handle') . '/',
                        'name' => $s->get('name'),
                        'type' => 'section',
                        'section' => array('id' => $s->get('id'), 'handle' => $s->get('handle')),
                        'visible' => ($s->get('hidden') === 'no' ? 'yes' : 'no')
                    );
                }
            }
        }

        /**
         * Given an associative array representing the navigation, and a group,
         * this function will attempt to return the index of the group in the navigation
         * array. If it is found, it will return the index, otherwise it will return false.
         *
         * @param array $nav
         *  An associative array of the navigation where the key is the group
         *  index, and the value is an associative array of 'name', 'index' and
         *  'children'. Name is the name of the this group, index is the same as
         *  the key and children is an associative array of navigation items containing
         *  the keys 'link', 'name' and 'visible'. The 'haystack'.
         * @param string $group
         *  The group name to find, the 'needle'.
         * @return integer|boolean
         *  If the group is found, the index will be returned, otherwise false.
         */
        private static function __navigationFindGroupIndex(array $nav, $group)
        {
            foreach ($nav as $index => $item) {
                if ($item['name'] === $group) {
                    return $index;
                }
            }

            return false;
        }

        /**
         * This method fills the `$nav` array with value
         * from each Extension's `fetchNavigation` method
         *
         * @since Symphony 2.3.2
         *
         * @param array $nav
         *  The navigation array that will receive nav nodes
         * @throws Exception
         * @throws SymphonyErrorPage
         */
        private function buildExtensionsNavigation(&$nav)
        {
            // Loop over all the installed extensions to add in other navigation items
            $extensions = Symphony::ExtensionManager()->listInstalledHandles();

            foreach ($extensions as $e) {
                $extension = Symphony::ExtensionManager()->getInstance($e);
                $extension_navigation = $extension->fetchNavigation();

                if (is_array($extension_navigation) && !empty($extension_navigation)) {
                    foreach ($extension_navigation as $item) {
                        $type = isset($item['children']) ? Extension::NAV_GROUP : Extension::NAV_CHILD;

                        switch ($type) {
                            case Extension::NAV_GROUP:
                                $index = General::array_find_available_index($nav, $item['location']);

                                // Actual group
                                $nav[$index] = self::createParentNavItem($index, $item);

                                // Render its children
                                foreach ($item['children'] as $child) {
                                    $nav[$index]['children'][] = self::createChildNavItem($child, $e);
                                }

                                break;

                            case Extension::NAV_CHILD:
                                if (!is_numeric($item['location'])) {
                                    // is a navigation group
                                    $group_name = $item['location'];
                                    $group_index = self::__navigationFindGroupIndex($nav, $item['location']);
                                } else {
                                    // is a legacy numeric index
                                    $group_index = $item['location'];
                                }

                                $child = self::createChildNavItem($item, $e);

                                if ($group_index === false) {
                                    $group_index = General::array_find_available_index($nav, 0);

                                    $nav_parent = self::createParentNavItem($group_index, $item);
                                    $nav_parent['name'] = $group_name;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                                    $nav_parent['children'] = array($child);

                                    // add new navigation group
                                    $nav[$group_index] = $nav_parent;
                                } else {
                                    // add new location by index
                                    $nav[$group_index]['children'][] = $child;
                                }

                                break;
                        }
                    }
                }
            }
        }

        /**
         * This function builds out a navigation menu item for parents. Parents display
         * in the top level navigation of the backend and may have children (dropdown menus)
         *
         * @since Symphony 2.5.1
         * @param integer $index
         * @param array $item
         * @return array
         */
        private static function createParentNavItem($index, $item)
        {
            $nav_item = array(
                'name' => $item['name'],
                'type' => isset($item['type']) ? $item['type'] : 'structure',
                'index' => $index,
                'children' => array(),
                'limit' => isset($item['limit']) ? $item['limit'] : null
            );

            return $nav_item;
        }

        /**
         * This function builds out a navigation menu item for children. Children
         * live under a parent navigation item and are shown on hover.
         *
         * @since Symphony 2.5.1
         * @param array $item
         * @param string $extension_handle
         * @return array
         */
        private static function createChildNavItem($item, $extension_handle)
        {
            if (!isset($item['relative']) || $item['relative'] === true) {
                $link = '/extension/' . $extension_handle . '/' . ltrim($item['link'], '/');
            } else {
                $link = '/' . ltrim($item['link'], '/');
            }

            $nav_item = array(
                'link' => $link,
                'name' => $item['name'],
                'visible' => (isset($item['visible']) && $item['visible'] === 'no') ? 'no' : 'yes',
                'limit' => isset($item['limit']) ? $item['limit'] : null,
                'target' => isset($item['target']) ? $item['target'] : null
            );

            return $nav_item;
        }

        // Errors first, success next, then notices.

        /**
         * Given the navigation array, this function will loop over all the items
         * to determine which is the 'active' navigation group, or in other words,
         * what group best represents the current page `$this->Author` is viewing.
         * This is done by checking the current page's link against all the links
         * provided in the `$nav`, and then flagging the group of the found link
         * with an 'active' CSS class. The current page's link omits any flags or
         * URL parameters and just uses the root page URL.
         *
         * @param array $nav
         *  An associative array of the navigation where the key is the group
         *  index, and the value is an associative array of 'name', 'index' and
         *  'children'. Name is the name of the this group, index is the same as
         *  the key and children is an associative array of navigation items containing
         *  the keys 'link', 'name' and 'visible'. The 'haystack'. This parameter is passed
         *  by reference to this function.
         * @param string $pageroot
         *  The current page the Author is the viewing, minus any flags or URL
         *  parameters such as a Symphony object ID. eg. Section ID, Entry ID. This
         *  parameter is also be a regular expression, but this is highly unlikely.
         * @param boolean $pattern
         *  If set to true, the `$pageroot` represents a regular expression which will
         *  determine if the active navigation item
         * @return boolean
         *  Returns true if an active link was found, false otherwise. If true, the
         *  navigation group of the active link will be given the CSS class 'active'
         */
        private static function __findActiveNavigationGroup(array &$nav, $pageroot, $pattern = false)
        {
            foreach ($nav as $index => $contents) {
                if (is_array($contents['children']) && !empty($contents['children'])) {
                    foreach ($contents['children'] as $item) {
                        if ($pattern && preg_match($pageroot, $item['link'])) {
                            $nav[$index]['class'] = 'active';

                            return true;
                        } elseif ($item['link'] === $pageroot) {
                            $nav[$index]['class'] = 'active';

                            return true;
                        }
                    }
                }
            }

            return false;
        }

        /**
         * Given the limit of the current navigation item or page, this function
         * returns if the current Author can access that item or not.
         *
         * @since Symphony 2.5.1
         * @param string $item_limit
         * @return boolean
         */
        public function doesAuthorHaveAccess($item_limit = null)
        {
            $can_access = false;

            if (!isset($item_limit) || $item_limit === 'author') {
                $can_access = true;
            } elseif ($item_limit === 'developer' && Symphony::Author()->isDeveloper()) {
                $can_access = true;
            } elseif ($item_limit === 'manager' && (Symphony::Author()->isManager() || Symphony::Author()->isDeveloper())) {
                $can_access = true;
            } elseif ($item_limit === 'primary' && Symphony::Author()->isPrimaryAccount()) {
                $can_access = true;
            }

            return $can_access;
        }

        /**
         * This function is called when `$_REQUEST` contains a key of 'action'.
         * Any logic that needs to occur immediately for the action to complete
         * should be contained within this function. By default this calls the
         * `__switchboard` with the type set to 'action'.
         *
         * @see __switchboard()
         */
        public function action()
        {
            $this->__switchboard('action');
        }

        /**
         * The `__switchboard` function acts as a controller to display content
         * based off the $type. By default, the `$type` is 'view' but it can be set
         * also set to 'action'. The `$type` is prepended by __ and the context is
         * append to the $type to create the name of the function that will provide
         * that logic. For example, if the $type was action and the context of the
         * current page was new, the resulting function to be called would be named
         * `__actionNew()`. If an action function is not provided by the Page, this function
         * returns nothing, however if a view function is not provided, a 404 page
         * will be returned.
         *
         * @param string $type
         *  Either 'view' or 'action', by default this will be 'view'
         * @throws SymphonyErrorPage
         */
        public function __switchboard($type = 'view')
        {
            if (empty($this->_context)) {
                $context = 'index';
            } else {
                $context = current($this->_context);
            }

            $function = ($type === 'action' ? '__action' : '__view') . ucfirst($context);

            if (!method_exists($this, $function)) {
                // If there is no action function, just return without doing anything
                if ($type === 'action') {
                    return;
                }

                Administration::instance()->errorPageNotFound();
            }

            $this->$function(null);
        }

        /**
         * Creates the Symphony footer for an Administration page. By default
         * this includes the installed Symphony version and the currently logged
         * in Author. A delegate is provided to allow extensions to manipulate the
         * footer HTML, which is an XMLElement of a `<ul>` element.
         * Since Symphony 2.3, it no longer uses the `AddElementToFooter` delegate.
         */
        public function appendUserLinks()
        {
            $ul = new XMLElement('ul', null, array('id' => 'session'));

            $li = new XMLElement('li');
            $li->appendChild(
                Widget::Anchor(
                    Symphony::Author()->getFullName(),
                    SYMPHONY_URL . '/system/authors/edit/' . Symphony::Author()->get('id') . '/'
                )
            );
            $ul->appendChild($li);

            $li = new XMLElement('li');
            $li->appendChild(Widget::Anchor(__('Log out'), SYMPHONY_URL . '/logout/', null, null, null,
                array('accesskey' => 'l')));
            $ul->appendChild($li);

            $this->Header->appendChild($ul);
        }

        /**
         * This function will append the Navigation to the AdministrationPage.
         * It fires a delegate, NavigationPreRender, to allow extensions to manipulate
         * the navigation. Extensions should not use this to add their own navigation,
         * they should provide the navigation through their fetchNavigation function.
         * Note with the Section navigation groups, if there is only one section in a group
         * and that section is set to visible, the group will not appear in the navigation.
         *
         * @uses NavigationPreRender
         * @see  getNavigationArray()
         * @see  toolkit.Extension#fetchNavigation()
         */
        public function appendNavigation()
        {
            $nav = $this->getNavigationArray();

            /**
             * Immediately before displaying the admin navigation. Provided with the
             * navigation array. Manipulating it will alter the navigation for all pages.
             *
             * @delegate NavigationPreRender
             * @param string $context
             *  '/backend/'
             * @param array $nav
             *  An associative array of the current navigation, passed by reference
             */
            Symphony::ExtensionManager()->notifyMembers('NavigationPreRender', '/backend/',
                array('navigation' => &$nav));

            $navElement = new XMLElement('nav', null, array('id' => 'nav', 'role' => 'navigation'));
            $contentNav = new XMLElement('ul', null, array('class' => 'content', 'role' => 'menubar'));
            $structureNav = new XMLElement('ul', null, array('class' => 'structure', 'role' => 'menubar'));

            foreach ($nav as $n) {
                if (isset($n['visible']) && $n['visible'] === 'no') {
                    continue;
                }

                if ($this->doesAuthorHaveAccess($n['limit'])) {
                    $xGroup = new XMLElement('li', $n['name'], array('role' => 'presentation'));

                    if (isset($n['class']) && trim($n['name']) !== '') {
                        $xGroup->setAttribute('class', $n['class']);
                    }

                    $hasChildren = false;
                    $xChildren = new XMLElement('ul', null, array('role' => 'menu'));

                    if (is_array($n['children']) && !empty($n['children'])) {
                        foreach ($n['children'] as $c) {
                            // adapt for Yes and yes
                            if (strtolower($c['visible']) !== 'yes') {
                                continue;
                            }

                            if ($this->doesAuthorHaveAccess($c['limit'])) {
                                $xChild = new XMLElement('li');
                                $xChild->setAttribute('role', 'menuitem');
                                $linkChild = Widget::Anchor($c['name'], SYMPHONY_URL . $c['link']);
                                if (isset($c['target'])) {
                                    $linkChild->setAttribute('target', $c['target']);
                                }
                                $xChild->appendChild($linkChild);
                                $xChildren->appendChild($xChild);
                                $hasChildren = true;
                            }
                        }

                        if ($hasChildren) {
                            $xGroup->setAttribute('aria-haspopup', 'true');
                            $xGroup->appendChild($xChildren);

                            if ($n['type'] === 'content') {
                                $contentNav->appendChild($xGroup);
                            } elseif ($n['type'] === 'structure') {
                                $structureNav->prependChild($xGroup);
                            }
                        }
                    }
                }
            }

            $navElement->appendChild($contentNav);
            $navElement->appendChild($structureNav);
            $this->Header->appendChild($navElement);
            Symphony::Profiler()->sample('Navigation Built', PROFILE_LAP);
        }

        /**
         * Called to build the content for the page. This function immediately calls
         * `__switchboard()` which acts a bit of a controller to show content based on
         * off a type, such as 'view' or 'action'. `AdministrationPages` can override this
         * function to just display content if they do not need the switchboard functionality
         *
         * @see __switchboard()
         */
        public function view()
        {
            $this->__switchboard();
        }

        /**
         * If `$this->Alert` is set, it will be added to this page. The
         * `AppendPageAlert` delegate is fired to allow extensions to provide their
         * their own Alert messages for this page. Since Symphony 2.3, there may be
         * more than one `Alert` per page. Alerts are displayed in the order of
         * severity, with Errors first, then Success alerts followed by Notices.
         *
         * @uses AppendPageAlert
         */
        public function appendAlert()
        {
            /**
             * Allows for appending of alerts. Administration::instance()->Page->Alert is way to tell what
             * is currently in the system
             *
             * @delegate AppendPageAlert
             * @param string $context
             *  '/backend/'
             */
            Symphony::ExtensionManager()->notifyMembers('AppendPageAlert', '/backend/');


            if (!is_array($this->Alert) || empty($this->Alert)) {
                return;
            }

            usort($this->Alert, array($this, 'sortAlerts'));

            // Using prependChild ruins our order (it's backwards, but with most
            // recent notices coming after oldest notices), so reversing the array
            // fixes this. We need to prepend so that without Javascript the notices
            // are at the top of the markup. See #1312
            $this->Alert = array_reverse($this->Alert);

            foreach ($this->Alert as $alert) {
                $this->Header->prependChild($alert->asXML());
            }
        }

        /**
         * Appends the `$this->Header`, `$this->Context` and `$this->Contents`
         * to `$this->Wrapper` before adding the ID and class attributes for
         * the `<body>` element. This function will also place any Drawer elements
         * in their relevant positions in the page. After this has completed the
         * parent `generate()` is called which will convert the `XMLElement`'s
         * into strings ready for output.
         *
         * @see core.HTMLPage#generate()
         * @param null $page
         * @return string
         */
        public function generate($page = null)
        {
            $this->Wrapper->appendChild($this->Header);

            // Add horizontal drawers (inside #context)
            if (isset($this->Drawer['horizontal'])) {
                $this->Context->appendChildArray($this->Drawer['horizontal']);
            }

            $this->Wrapper->appendChild($this->Context);

            // Add vertical-left drawers (between #context and #contents)
            if (isset($this->Drawer['vertical-left'])) {
                $this->Contents->appendChildArray($this->Drawer['vertical-left']);
            }

            // Add vertical-right drawers (after #contents)
            if (isset($this->Drawer['vertical-right'])) {
                $this->Contents->appendChildArray($this->Drawer['vertical-right']);
            }

            $this->Wrapper->appendChild($this->Contents);

            $this->Body->appendChild($this->Wrapper);

            $this->__appendBodyId();
            $this->__appendBodyAttributes($this->_context);

            return parent::generate($page);
        }

        /**
         * Uses this pages PHP classname as the `<body>` ID attribute.
         * This function removes 'content' from the start of the classname
         * and converts all uppercase letters to lowercase and prefixes them
         * with a hyphen.
         */
        private function __appendBodyId()
        {
            // trim "content" from beginning of class name
            $body_id = preg_replace("/^content/", '', get_class($this));

            // lowercase any uppercase letters and prefix with a hyphen
            $body_id = trim(
                preg_replace_callback(
                    "/([A-Z])/",
                    function ($id) {
                        return "-" . strtolower($id[0]);
                    },
                    $body_id
                ),
                '-'
            );

            if (!empty($body_id)) {
                $this->Body->setAttribute('id', $body_id);
            }
        }

        /**
         * Given the context of the current page, which is an associative
         * array, this function will append the values to the page's body as
         * data attributes. If an context value is numeric it will be given
         * the key 'id' otherwise all attributes will be prefixed by the context key.
         *
         * If the context value is an array, it will be JSON encoded.
         *
         * @param array $context
         */
        private function __appendBodyAttributes(array $context = array())
        {
            foreach ($context as $key => $value) {
                if (is_numeric($value)) {
                    $key = 'id';

                    // Add prefixes to all context values by making the
                    // class be {key}-{value}. #1397 ^BA
                } elseif (!is_numeric($key) && isset($value)) {
                    $key = str_replace('_', '-', $key);
                }

                // JSON encode any array values
                if (is_array($value)) {
                    $value = json_encode($value);
                }

                $this->Body->setAttribute('data-' . $key, $value);
            }
        }

        public function sortAlerts($a, $b)
        {
            if ($a->{'type'} === $b->{'type'}) {
                return 0;
            }

            if (
                ($a->{'type'} === Alert::ERROR && $a->{'type'} !== $b->{'type'})
                || ($a->{'type'} === Alert::SUCCESS && $b->{'type'} === Alert::NOTICE)
            ) {
                return -1;
            }

            return 1;
        }
    }

GitHub Access Token became invalid

Pull Request — integration (#2604)

AdministrationPage::insertBreadcrumbs() B

Complexity

Size

Duplication

Importance

Available Fixes

symphonycms / symphony-2

GitHub Access Token became invalid

Pull Request — integration (#2604)

AdministrationPage::insertBreadcrumbs() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like
