Просмотр архива BootHelp - PHP Helpers for Bootstrap


<?php

/**
 * BootHelp - PHP Helpers for Bootstrap
 *
 * (The MIT License)
 *
 * Copyright (c) 2015 Jorge Cobis <jcobis@gmail.com / http://twitter.com/cobisja>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace cobisjaBootHelp;

use cobisjaBootHelpBase;
use cobisjaBootHelpHelpersContentTag;

/**
 * Generates an HTML block tag that follows the Bootstrap documentation
 * on how to display <strong>Panel</strong> component.
 *
 * See {@link http://getbootstrap.com/components/#panels} for more information.
 */
class Panel extends Base
{
    /**
     * Initializes the Panel instance.
     *
     * @param mixed    $content_or_options_with_block the content to display in the panel.
     * @param mixed    $options [optional] the display options for the panel.
     * @param Callable $block [optional] Block to generate a customized inside panel content.
     */
    public function __construct($content_or_options_with_block = null, $options = null, $block = null)
    {
        $html = '';
        $num_args = $this->getFunctionNumArgs(func_get_args());

        if ($num_args < 3 && is_callable(func_get_arg($num_args-1))) {
            $block = func_get_arg($num_args-1);
            
            $html = $this->buildPanel(
                call_user_func($block),
                is_null($content_or_options_with_block) ? [] : $content_or_options_with_block
            );
        } elseif (is_array($content_or_options_with_block) && is_null($options)) {
            $html = $this->buildPanel(null, $content_or_options_with_block);
        } else {
            $html = $this->buildPanel($content_or_options_with_block, is_null($options) ? [] : $options);
        }

        $this->setHtmlObject($html->getHtmlObject());
    }

    /**
     * Builds the Panel object
     *
     * @param mixed $content Panel's content.
     * @param array $options Panel's options.
     * 
     * @return ContentTag a ContentTag instance that represents a Panel object.
     */
    private function buildPanel($content = null, $options = [])
    {
        !is_array($options) ? $options = [] : null;

        $body = $this->buildPanelBody($content);
        $heading = $this->buildPanelHeading($options);
        $footer = $this->buildPanelFooter($options);

        if (isset($options['tag'])) {
            $tag = $options['tag'];
            unset($options['tag']);
        } else {
            $tag = 'div';
        }

        if (isset($options['context'])) {
            $context = $options['context'];
            unset($options['context']);
        } else {
            $context = null;
        }

        $this->appendClass($options, $this->getPanelClass($context));

        $panel_string = new ContentTag($tag, $options, function () use ($heading, $body, $footer) {
            return [$heading, $body, $footer];
        });

        if (!is_null(Base::getPanelColumnClass())) {
            $panel_string = new ContentTag('div', $panel_string, ['class'=>Base::getPanelColumnClass()]);
        }

        return $panel_string;
    }

    /**
     * Return the context panel class.
     *
     * @param string $context context.
     * 
     * @return string context panel class.
     */
    private function getPanelClass($context = null)
    {
        $valid_contexts = ['primary', 'success', 'info', 'warning', 'danger'];
        $context = $this->contextFor($context, ['valid' => $valid_contexts]);

        return "panel panel-$context";
    }

    /**
     * Builds the Panel's body.
     *
     * @param mixed $content Panel's content.
     * 
     * @return ContentTag ContenTag instance that represents the Panel's body.
     */
    private function buildPanelBody($content)
    {
        return new ContentTag('div', $content, ['class' => 'panel-body']);
    }

    /**
     * Builds the Panel's header.
     *
     * @param array $options options information about Panel's header.
     * 
     * @return string Panel's header.
     */
    private function buildPanelHeading(&$options = [])
    {
        if (isset($options['title'])) {
            $title = new ContentTag('h3', $options['title'], ['class' => 'panel-title']);
            unset($options['title']);
        } elseif (isset($options['heading'])) {
            $title = $options['heading'];
            unset($options['heading']);
        } else {
            $title = null;
        }

        $heading = !is_null(($title)) ? new ContentTag('div', $title, ['class' => 'panel-heading']) : '';

        return $heading;
    }

    /**
     * Builds the Panel's footer.
     *
     * @param array $options options information about Panel's footer.
     * 
     * @return string Panel's footer.
     */

    private function buildPanelFooter(&$options = [])
    {
        if (isset($options['footer'])) {
            $footer = new ContentTag('div', $options['footer'], ['class' => 'panel-footer']);
            unset($options['footer']);
        } else {
            $footer = '';
        }

        return $footer;
    }
}