BootPress\Bootstrap\Bootstrap3Navbar

Complexity

Total Complexity

16

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
C	open()	0	37	7
A	menu()	0	7	2
A	button()	0	10	2
A	search()	0	8	2
A	text()	0	6	2
A	close()	0	4	1

<?php

namespace BootPress\Bootstrap;

class Bootstrap3Navbar extends Bootstrap3
{
    
    /**
     * This will open a new navbar.
     * 
     * @param mixed  $brand    The name of your website. If this is a string then it will automatically link to your ``$page->url['base']``. If you want to override that, then make this an ``array($brand, $link)``.
     * @param string $align    Either '**top**', '**bottom**', or '**static**' if you want to fix the alignment. If you are just trying to get to the next arg then you can declare '**inverse**' here and we will know what you are talking about.
     * @param mixed  $inverse  If this is anything but false (eg. '****inverse**') then we will display the inverted or alternate navbar.
     * 
     * @return string
     * 
     * ```php
     * echo $bp->navbar->open($ci->blog->get('name'), 'top', 'inverse');
     * ```
     */
    public function open($brand, $align = '', $inverse = false)
    {
        if (is_array($brand)) {
            list($brand, $link) = each($brand);
        } else {
            $link = $this->page->url['base'];
        }
        $id = $this->page->id('navbar');
        $class = 'navbar';
        switch ($align) {
            case 'top':
            case 'bottom':
                $class .= ' navbar-fixed-'.$align;
                break;
            case 'static':
                $class .= ' navbar-static-top';
                break;
            case 'inverse':
                $inverse = 'inverse';
                break;
        }
        $class .= ($inverse !== false) ? ' navbar-inverse' : ' navbar-default';
        $html = '<nav class="'.$class.'">';
        $html .= '<div class="container-fluid">';
        $html .= '<div class="navbar-header">';
        $html .= $this->page->tag('button', array(
                        'type' => 'button',
                        'class' => 'navbar-toggle collapsed',
                        'data-toggle' => 'collapse',
                        'data-target' => '#'.$id,
                    ), '<span class="sr-only">Toggle navigation</span>'.str_repeat('<span class="icon-bar"></span>', 3));
        $html .= "\n\t".$this->page->tag('a', array('class' => 'navbar-brand', 'href' => $link), $brand);
        $html .= '</div>';
        $html .= '<div class="collapse navbar-collapse" id="'.$id.'">';

        return "\n".$html;
    }

    /**
     * This will create a menu of links across your navbar.
     * 
     * @param array $links    An ``array($name => $href, ...)`` of links. If ``$href`` is an array unto itself, then it will be turned into a dropdown menu with the same header and divider rules applied as with buttons.
     * @param array $options  The options available here are:
     * 
     * - '**active**' => $name, $href, 'url', 'urlquery', or number (starting from 1)
     * - '**disabled**' => $name or $href or number (starting from 1)
     * - '**pull**' => 'left' (default) or 'right'
     * 
     * @return string
     * 
     * ```php
     * echo $bp->navbar->menu(array(
     *     'Home' => '#',
     *     'Work' => '#',
     *     'Dropdown' => array(
     *         'Action' => '#',
     *         'More' => '#',
     *     ),
     * ), array('active'=>'Home'));
     * ```
     */
    public function menu(array $links, array $options = array()) // array('active'=>'name or url', 'pull'=>'left or right')
    {
        $align = (isset($options['pull'])) ? ' navbar-'.$options['pull'] : '';
        unset($options['pull']);

        return "\n\t".'<ul class="nav navbar-nav'.$align.'">'.$this->links('li', $links, $options).'</ul>';
    }

    /**
     * This is used in exactly the same manner as $bp->button(...), except that it will be added to the navbar, and receive the navbar-btn class.
     * 
     * @param string $class 
     * @param string $name 
     * @param array  $options  
     * 
     * @return string
     */
    public function button($class, $name, array $options = array())
    {
        $class .= ' navbar-btn';
        if (isset($options['pull'])) {
            $class .= ' navbar-'.$options['pull'];
        }
        unset($options['pull']);

        return "\n\t".parent::button($class, $name, $options);
    }

    /**
     * This is used in exactly the same manner as ``$bp->search(...)``, but modified slightly for use in a navbar.
     * 
     * @param string $url   The same as it's parent.
     * @param array  $form  The same as it's parent, except for the default '**class**' which is '**navbar-form navbar-right**'.
     * 
     * @return string
     * 
     * ```php
     * echo $bp->navbar->search($page->url());
     * ```
     */
    public function search($url, array $form = array())
    {
        if (!isset($form['class'])) {
            $form['class'] = 'navbar-form navbar-right';
        }

        return "\n\t".parent::search($url, $form);
    }

    /**
     * This adds a string of text to the navbar. It will be wrapped in a ``<p>`` tag, and any ``<a>``'s it finds will also receive their special class treatment.
     * 
     * @param string $string  The message you would like to get across.
     * @param string $pull    Either '**left**' or '**right**'.
     * 
     * @return string
     * 
     * ```php
     * echo $bp->navbar->text('You <a href="#">link</a> me');
     * ```
     */
    public function text($string, $pull = false)
    {
        $align = (in_array($pull, array('left', 'right'))) ? ' navbar-'.$pull : '';

        return "\n\t".'<p class="navbar-text'.$align.'">'.$this->addClass($string, array('a' => 'navbar-link')).'</p>';
    }

    /**
     * This method will add the final ``<div>``'s to your navbar.
     * 
     * @return string
     * 
     * ```php
     * echo $bp->navbar->close();
     * ```
     */
    public function close()
    {
        return "</div></div>\n</nav>";
    }
}