Html

Complexity

Total Complexity

34

Size/Duplication

Total Lines	332
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	table()	0	24	3
A	buildUlOl()	0	24	3
A	buildTableBody()	0	16	1
A	buildTableFooter()	0	20	2
A	hr()	0	10	3
A	buildTableHeader()	0	20	2
A	head()	0	11	3
A	buildTableBodyContent()	0	12	4
A	br()	0	10	3
A	ol()	0	5	2
A	anchor()	0	16	3
A	ul()	0	5	2
A	mailto()	0	14	3

<?php
    defined('ROOT_PATH') || exit('Access denied');
    /**
     * TNH Framework
     *
     * A simple PHP framework using HMVC architecture
     *
     * This content is released under the MIT License (MIT)
     *
     * Copyright (c) 2017 TNH Framework
     *
     * 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.
     */

    class Html {

        /**
         * Generate the html anchor link
         * 
         * @param  string $link       the href attribute value
         * @param  string $anchor     the displayed anchor
         * @param  array  $attributes the additional attributes to be added
         * @param boolean $return whether need return the generated html or just display it directly
         *
         * @return string|void the anchor link generated html if $return is true or display it if not
         */
        public static function anchor($link = '', $anchor = null, array $attributes = array(), $return = true) {
            $link = get_instance()->url->appUrl($link);
            if (!$anchor) {
                $anchor = $link;
            }
            $str = null;
            $str .= '<a href = "' . $link . '"';
            $str .= attributes_to_string($attributes);
            $str .= '>';
            $str .= $anchor;
            $str .= '</a>';

            if ($return) {
                return $str;
            }
            echo $str;
        }
		
        /**
         * Generate an mailto anchor link
         * 
         * @param  string $link       the email address 
         * @param  string $anchor     the displayed value of the link
         * @param  array  $attributes the additional attributes to be added
         * @param boolean $return whether need return the generated html or just display it directly
         *
         * @return string|void the generated html for mailto link if $return is true or display it if not
         */
        public static function mailto($link, $anchor = null, array $attributes = array(), $return = true) {
            if (!$anchor) {
                $anchor = $link;
            }
            $str = null;
            $str .= '<a href = "mailto:' . $link . '"';
            $str .= attributes_to_string($attributes);
            $str .= '>';
            $str .= $anchor;
            $str .= '</a>';
            if ($return) {
                return $str;
            }
            echo $str;
        }

        /**
         * Generate the html "br" tag  
         * 
         * @param  integer $nb the number of generated "<br />" tag
         * @param boolean $return whether need return the generated html or just display it directly
         *
         * @return string|void      the generated "br" html if $return is true or display it if not
         */
        public static function br($nb = 1, $return = true) {
            $nb = (int) $nb;
            $str = null;
            for ($i = 1; $i <= $nb; $i++) {
                $str .= '<br />';
            }
            if ($return) {
                return $str;
            }
            echo $str;
        }

        /**
         * Generate the html content for tag "hr"
         * 
         * @param integer $nb the number of generated "<hr />" tag
         * @param  array   $attributes the tag attributes
         * @param  boolean $return    whether need return the generated html or just display it directly
         *
         * @return string|void the generated "hr" html if $return is true or display it if not.
         */
        public static function hr($nb = 1, array $attributes = array(), $return = true) {
            $nb = (int) $nb;
            $str = null;
            for ($i = 1; $i <= $nb; $i++) {
                $str .= '<hr' . attributes_to_string($attributes) . ' />';
            }
            if ($return) {
                return $str;
            }
            echo $str;
        }

        /**
         * Generate the html content for tag like h1, h2, h3, h4, h5 and h6
         * 
         * @param  integer $type       the tag type 1 mean h1, 2 h2, etc,
         * @param  string  $text       the display text
         * @param integer $nb the number of generated "<h{1,2,3,4,5,6}>"
         * @param  array   $attributes the tag attributes
         * @param  boolean $return    whether need return the generated html or just display it directly
         *
         * @return string|void the generated header html if $return is true or display it if not.
         */
        public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true) {
            $nb = (int) $nb;
            $type = (int) $type;
            $str = null;
            for ($i = 1; $i <= $nb; $i++) {
                $str .= '<h' . $type . attributes_to_string($attributes) . '>' . $text . '</h' . $type . '>';
            }
            if ($return) {
                return $str;
            }
            echo $str;
        }

        /**
         * Generate the html "ul" tag
         * 
         * @param  array   $data the data to use for each "li" tag
         * @param  array   $attributes   the "ul" properties attribute use the array index below for each tag:
         *  for ul "ul", for li "li".
         * @param  boolean $return whether need return the generated html or just display it directly
         *
         * @return string|void the generated "ul" html  if $return is true or display it if not.
         */
        public static function ul(array $data = array(), array $attributes = array(), $return = true) {
            if ($return) {
                return self::buildUlOl($data, $attributes, true, 'ul');
            }
            self::buildUlOl($data, $attributes, false, 'ul');
        }

        /**
         * Generate the html "ol" tag
         * 
         * @param  array   $data the data to use for each "li" tag
         * @param  array   $attributes   the "ol" properties attribute use the array index below for each tag:
         *  for ol "ol", for li "li".
         * @param  boolean $return whether need return the generated html or just display it directly
         * 
         * @return string|void the generated "ol" html  if $return is true or display it if not.
         */
        public static function ol(array $data = array(), array $attributes = array(), $return = true) {
            if ($return) {
                return self::buildUlOl($data, $attributes, true, 'ol');
            }
            self::buildUlOl($data, $attributes, false, 'ol');
        }


        /**
         * Generate the html "table" tag
         * 
         * @param  array   $headers the table headers to use between (<thead>)
         * @param  array   $body the table body values between (<tbody>)
         * @param  array   $attributes   the table properties attribute use the array index below for each tag:
         *  for table "table", for thead "thead", for thead tr "thead_tr",
         *  for thead th "thead_th", for tbody "tbody", for tbody tr "tbody_tr", 
         *  for tbody td "tbody_td", for tfoot "tfoot",
         *  for tfoot tr "tfoot_tr", for tfoot th "tfoot_th".
         * @param boolean $useFooter whether need to generate table footer (<tfoot>) use the $headers values
         * @param  boolean $return whether need return the generated html or just display it directly
         * 
         * @return string|void the generated "table" html  if $return is true or display it if not.
         */
        public static function table(
                                    array $headers = array(), 
                                    array $body = array(), 
                                    array $attributes = array(), 
                                    $useFooter = false, 
                                    $return = true
                                ) {
            $str = null;
            $defaultAttributes = array();
            $defaultAttributes['table'] = array();
            $attributes = array_merge($defaultAttributes, $attributes);
            $tableAttributes = attributes_to_string($attributes['table']);
            $str .= '<table' . $tableAttributes . '>';
            $str .= self::buildTableHeader($headers, $attributes);
            $str .= self::buildTableBody($body, $attributes);

            if ($useFooter) {
                $str .= self::buildTableFooter($headers, $attributes);
            }
            $str .= '</table>';
            if ($return) {
                return $str;
            }
            echo $str;
        }

        /**
         * This method is used to build the header of the html table
         * 
         * @see  Html::table 
         * @return string|null
         */
        protected static function buildTableHeader(array $headers, array $attributes = array()) {
            $str = null;
            $defaultAttributes = array();
            $defaultAttributes['thead'] = array();
            $defaultAttributes['thead_tr'] = array();
            $defaultAttributes['thead_th'] = array();
            $attributes = array_merge($defaultAttributes, $attributes);

            $theadAttributes = attributes_to_string($attributes['thead']);
            $theadtrAttributes = attributes_to_string($attributes['thead_tr']);
            $thAttributes = attributes_to_string($attributes['thead_th']);

            $str .= '<thead' . $theadAttributes . '>';
            $str .= '<tr' . $theadtrAttributes . '>';
            foreach ($headers as $value) {
                $str .= '<th' . $thAttributes . '>' . $value . '</th>';
            }
            $str .= '</tr>';
            $str .= '</thead>';
            return $str;
        }

        /**
         * This method is used to build the body of the html table
         * 
         * @see  Html::table 
         * @return string|null
         */
        protected static function buildTableBody(array $body, array $attributes = array()) {
            $str = null;
            $defaultAttributes = array();
            $defaultAttributes['tbody'] = array();
            $defaultAttributes['tbody_tr'] = array();
            $defaultAttributes['tbody_td'] = array();
            $attributes = array_merge($defaultAttributes, $attributes);
            
            $tbodyAttributes = attributes_to_string($attributes['tbody']);
            $tbodytrAttributes = attributes_to_string($attributes['tbody_tr']);
            $tbodytdAttributes = attributes_to_string($attributes['tbody_td']);
            
            $str .= '<tbody' . $tbodyAttributes . '>';
            $str .= self::buildTableBodyContent($body, $tbodytrAttributes, $tbodytdAttributes);
            $str .= '</tbody>';
            return $str;
        }

        /**
         * This method is used to build the body content of the html table
         * 
         * @param  array  $body the table body data
         * @param  string $tbodytrAttributes the html attributes for each tr in tbody
         * @param  string $tbodytdAttributes the html attributes for each td in tbody
         * @return string                    
         */
        protected static function buildTableBodyContent(array $body, $tbodytrAttributes, $tbodytdAttributes) {
            $str = null;
            foreach ($body as $row) {
                if (is_array($row)) {
                    $str .= '<tr' . $tbodytrAttributes . '>';
                    foreach ($row as $value) {
                        $str .= '<td' . $tbodytdAttributes . '>' . $value . '</td>';	
                    }
                    $str .= '</tr>';
                }
            }
            return $str;
        }

        /**
         * This method is used to build the footer of the html table
         * 
         * @see  Html::table 
         * @return string|null
         */
        protected static function buildTableFooter(array $footers, array $attributes = array()) {
            $str = null;
            $defaultAttributes = array();
            $defaultAttributes['tfoot'] = array();
            $defaultAttributes['tfoot_tr'] = array();
            $defaultAttributes['tfoot_th'] = array();
            $attributes = array_merge($defaultAttributes, $attributes);
            
            $tfootAttributes = attributes_to_string($attributes['tfoot']);
            $tfoottrAttributes = attributes_to_string($attributes['tfoot_tr']);
            $thAttributes = attributes_to_string($attributes['tfoot_th']);
            
            $str .= '<tfoot' . $tfootAttributes . '>';
                $str .= '<tr' . $tfoottrAttributes . '>';
                foreach ($footers as $value) {
                    $str .= '<th' . $thAttributes . '>' . $value . '</th>';
                }
                $str .= '</tr>';
                $str .= '</tfoot>';
            return $str;
        }

        /**
         * Return the HTML content for ol or ul tags
         * 
         * @see  Html::ol
         * @see  Html::ul
         * @param  string  $olul   the type 'ol' or 'ul'
         * 
         * @return void|string
         */
        protected static function buildUlOl(
                                            array $data = array(), 
                                            array $attributes = array(), 
                                            $return = true, 
                                            $olul = 'ul'
                                        ) {
            $str = null;
            $defaultAttributes = array();
            $defaultAttributes[$olul] = array();
            $defaultAttributes['li'] = array();
            $attributes = array_merge($defaultAttributes, $attributes);
            
            $olulAttributes = attributes_to_string($attributes[$olul]);
            $liAttributes = attributes_to_string($attributes['li']);
            
            $str .= '<' . $olul . $olulAttributes . '>';
            foreach ($data as $row) {
                $str .= '<li' . $liAttributes . '>' . $row . '</li>';
            }
            $str .= '</' . $olul . '>';
            if ($return) {
                return $str;
            }
            echo $str;
        }
    }