SWDB/application/helper/HTML_Helper.php

<?php
    /**
     * HTML helper file.
     *
     * Provides a helper to perform HTML operations.
     *
     * @category Helper.
     */

    /**
     * Require dependent files if not present.
     */
    require_once(PATH::HELPER . "Helper.php");
    require_once(PATH::ENTITY . "Unit.php");
    require_once(PATH::ENTITY . "K_Unit.php");
    require_once(PATH::ENTITY . "Building.php");
    require_once(PATH::ENTITY . "K_Building.php");
    require_once(PATH::ENTITY . "Decoration.php");
    require_once(PATH::ENTITY . "K_Decoration.php");
    require_once(PATH::ENTITY . "Rune.php");
    require_once(PATH::ENTITY . "Artifact.php");
    require_once(PATH::ENTITY . "Rune_Craft.php");
    require_once(PATH::ENTITY . "Inventory.php");

    /**
     * HTML helper.
     *
     * Contains utilities to parse and format HTML and to build elements.
     *
     * @category Helper.
     */
    final class HTML extends Helper{

        /**
         * Escapes HTML characters
         * 
         * Alias for htmlspecialchars([input], ENT_QUOTES)
         *
         * @param string $input Text to escape.
         * @return string Escaped text.
         */
        public static function e($input){
           return htmlspecialchars($input, ENT_QUOTES);
        }

        /**
         * Generates a unit panel.
         * 
         * @param Unit|K_Unit Entity to get the info from.
         * @return string HTML content for a monster panel. Empty on error.
         */
        public static function unit_panel($unit) {
            if ($unit instanceof Unit){
                $k = $unit->unit;
                $stars = $unit->stars;
                $level = true;
                $teams = (sizeof($unit->teams) > 0);
                $lock = $unit->lock;
                $storage = $unit->in_storage;
                $maxed = ($unit->level == 40 && $unit->are_skills_maxed());
            }
            elseif ($unit instanceof K_Unit){
                $k = $unit;
                $stars = $unit->base_stars;
                $level = false;
                $teams = 0;
                $lock = false;
                $storage = false;
                $maxed = false;
            }
            else{
                return "";
            }
            $html = "";
            if ($k->awakens_from == "" && $k->awakens_to == ""){
                // No to, no from, silver monster.
                $star_class ="star_silver";
            }
            elseif ($k->awakens_from != ""){
                // Already awakened
                if ($k->base_stars - $k->natural_stars == 1){
                    // Normal awaken.
                    $star_class ="star_purple";
                }
                else{
                    // Second awaken.
                    $star_class ="star_red";
                }
            }
            elseif ($k->awakens_to != ""){
                // Awakeable.
                $star_class ="star_gold";
            }
            $html .= "<span class='stars'>\n";
            for ($i = 0; $i < $stars; $i ++){
                $html .= "<img class='star $star_class' src='" . URL::IMG["ICON"] . "star.png'/>\n";
            }
            $html .= "</span>\n";
            $html .= "<img title='" . $unit->title . "' class='monster border_" . $k->element_name . "' src='" . $k->get_image() . "'/>\n";
            if ($level){
                $html .= "<span class='level'>\n";
                $html .= $unit->level . "\n";
                $html .= "</span>\n";
            }
            $html .= "<span class='badges'>\n";
            if ($maxed){
                $html .= "<img title='Maxed unit' src='" . URL::IMG["ICON"] . "maxed.png'>";
            }
            if ($teams > 0){
                $title = $teams . " teams";
                if ($teams == 1){
                    $title = "1 team: " . $unit->teams[0]->name;
                }
                $html .= "<img title='$title' src='" . URL::IMG["ICON"] . "team.png'>";
            }
            if ($lock == 1){
                $html .= "<img title='Locked' src='" . URL::IMG["ICON"] . "lock.png'>";
            }
            if ($storage){
                $html .= "<img title='In storage' src='" . URL::IMG["ICON"] . "storage.png'>";
            }

            $html .= "</span>\n";
            return $html;
        }

        /**
         * Generates a transformed monster panel.
         * 
         * @param Unit|K_Unit Entity to get the info from.
         * @return string HTML content for a monster panel. Empty on error.
         */
        public static function unit_transformation_panel($unit) {
            $html = "";
            if ($unit instanceof Unit){
                $k = $unit->unit;
            }
            elseif ($unit instanceof K_Unit){
                $k = $unit;
            }
            else{
                return "";
            }
            if ($k->transformation == null){
                return "";
            }
            $html .= "<div class='monster_transformation_panel'>\n";
            $html .= "<img title='" . $unit->title . " (transformed)' class='monster_transformation border_" . $k->element_name . "' src='" . $k->transformation->get_image() . "'/>\n";
            $html .= "</div>\n";
            return $html;
        }

        /**
         * Generates a rune panel.
         * 
         * @param Rune rune Entity to get the info from.
         * @param Unit unit Optional. The unit the rune is assigned to.
         * @return string HTML content for a rune panel. Empty on error.
         */
        public static function rune_panel($rune, $unit = null) {
            if (!($rune instanceof Rune)){
                return "";
            }
            $html = "";
            $html .= "<div class='rune_panel rune_slot_" . $rune->slot . " rune_level_" . $rune->level . " rune_quality_" . strtolower($rune->quality_name) . " rune_original_quality_" . strtolower($rune->original_quality_name) . " rune_ancient_" . $rune->ancient . "'>\n";
            $html .= "<img class='rune_base' src='" . URL::IMG["RUNE"] . "base.png'/>\n";
            $html .= "<img class='rune_icon' src='" . $rune->type->get_image() . "'/>\n";
            $html .= "<span class='rune_stars'>\n";
            for ($i = 0; $i < $rune->stars; $i ++){
                $html .= "<img class='star' src='" . URL::IMG["ICON"] . "star.png'/>\n";
            }
            $html .= "</span>\n";
            $html .= "<span class='rune_level'>\n";
            $html .= $rune->level . "\n";
            $html .= "</span>\n";
            $html .= "</div>\n";
            if ($unit instanceof Unit){
                $html .= "<div class='assigned'>\n";
                $html .= "<a target='blank' href='/monsters/" . $unit->id . "'>\n";
                $html .= "<img title='" . $unit->title . "' class='monster_image border_" . $unit->unit->element_name . "' src='" . $unit->unit->get_image() . "'/>\n";
                $html .= "</a>\n";
                $html .= "</div>\n";
            }
            return $html;
        }

        /**
         * Generates a rune table.
         * 
         * @param Rune rune Entity to get the info from.
         * @param Unit unit Optional. The unit the rune is assigned to.
         * @return string HTML content for a rune table. Empty on error.
         */
        public static function rune_table($rune, $unit = null) {
            if (!($rune instanceof Rune)){
                return "";
            }
            $html = "";
            $html .= "<table class='rune' id='rune-" . $rune->id . "'>\n";
            $html .= "<tr>\n";
            $html .= "<td class='icon'>\n";
            $html .= HTML::rune_panel($rune, $unit) . "\n";
            $html .= "</td>\n";
            $html .= "<td class='stats'>\n";
            $html .= "<table>\n";
            // Main stat
            $html .= "<tr class='main_stat'>\n";
            $html .= "<td class='stat'>\n";
            if (in_array($rune->main_stat_name, array("CRR", "CRD", "RES", "ACC", "HP%", "ATK%", "DEF%"))){
                $stat_name = str_replace("%", "", $rune->main_stat_name);
                $stat_value = "+ " . $rune->main_stat_value . "%";
            }
            else{
                $stat_name = $rune->main_stat_name;
                $stat_value = "+ " . $rune->main_stat_value;
            }
            $html .= $stat_name . "\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= $stat_value . "\n";
            $html .= "<td>\n";
            $html .= "</tr>\n";
            // Innate stat
            $html .= "<tr class='innate_stat'>\n";
            $html .= "<td class='stat'>\n";
            if (strlen($rune->innate_stat) == 0){
                $stat_name = "&nbsp;";
                $stat_value = "";
            }
            elseif (in_array($rune->innate_stat_name, array("CRR", "CRD", "RES", "ACC", "HP%", "ATK%", "DEF%"))){
                $stat_name = str_replace("%", "", $rune->innate_stat_name);
                $stat_value = "+ " . $rune->innate_stat_value . "%";
            }
            else{
                $stat_name = $rune->innate_stat_name;
                $stat_value = "+ " . $rune->innate_stat_value;
            }
            $html .= $stat_name . "\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= $stat_value . "\n";
            $html .= "<td>\n";
            $html .= "</tr>\n";
            $substats = array($rune->substat_1, $rune->substat_2, $rune->substat_3, $rune->substat_4);
            $substats_name = array($rune->substat_1_name, $rune->substat_2_name, $rune->substat_3_name, $rune->substat_4_name);
            $substats_value = array($rune->substat_1_value, $rune->substat_2_value, $rune->substat_3_value, $rune->substat_4_value);
            $substats_grind = array($rune->substat_1_grind, $rune->substat_2_grind, $rune->substat_3_grind, $rune->substat_4_grind);
            $substats_enchant = array($rune->substat_1_enchant, $rune->substat_2_enchant, $rune->substat_3_enchant, $rune->substat_4_enchant);
            for ($i = 0; $i < 4; $i ++){
                if (strlen($substats_name[$i]) == 0){
                    $stat_name = "&nbsp;";
                    $stat_value = "";
                }
                elseif (in_array($substats_name[$i], array("CRR", "CRD", "RES", "ACC", "HP%", "ATK%", "DEF%"))){
                    $stat_name = str_replace("%", "", $substats_name[$i]);
                    $stat_value = "+ " . $substats_value[$i] . "%";
                }
                else{
                    $stat_name = $substats_name[$i];
                    $stat_value = "+ " . $substats_value[$i];
                }
                $grind = "";
                if ($substats_grind[$i] > 0){
                    $grind = "+" . $substats_grind[$i];
                    if (in_array($substats_name[$i], array("CRR", "CRD", "RES", "ACC", "HP%", "ATK%", "DEF%"))){
                        $grind = $grind . "%";
                    }
                }
                $html .= "<tr class=substat>\n";
                $html .= "<td class='stat'>\n";
                $html .= $stat_name . "\n";
                $html .= "</td>\n";
                $html .= "<td class='value'>\n";
                $html .= $stat_value . "\n";
                $html .= "<span class='grind grind_$grind'>\n";
                $html .= $grind . "\n";
                $html .= "</span>\n";
                if ($substats_enchant[$i] == 1){
                    $html .= "<img title='Enchanted' src='" . URL::IMG["RUNE"] . "enchanted.png'/>\n";
                }
                $html .= "</td>\n";
                $html .= "</tr>\n";
            }
            $html .= "</table>\n";
            $html .= "</td>\n";
            // Details
            $html .= "<td class='details'>\n";
            $html .= "<table class='table_details'>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Quality:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= "<span class='quality quality_" . strtolower($rune->quality_name) . "'>\n";
            $html .= $rune->quality_name . "\n";
            $html .= "</span>\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Original q.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= "<span class='quality quality_" . strtolower($rune->original_quality_name) . "'>\n";
            $html .= $rune->original_quality_name . "\n";
            $html .= "</span>\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Value:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= number_format($rune->value, 0, ".", ",") . "\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Efficiency:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= number_format($rune->efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Max. eff.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= number_format($rune->max_efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Reached. eff.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= number_format($rune->efficiency * 100 / $rune->max_efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "</table>\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "</table>\n";
            return $html;
        }

        // TODO: Icon and background selection must go in the entity code.
        /**
         * Generates an artifact panel.
         * 
         * @param Artifact artifact Entity to get the info from.
         * @param Unit unit Optional. The unit the artifact is assigned to.
         * @return string HTML content for an artifact panel. Empty on error.
         */
        public static function artifact_panel($artifact, $unit = null) {
            if (!($artifact instanceof Artifact)){
                return "";
            }
            $html = "";
            $html .= "<div class='artifact_panel artifact_level_" . $artifact->level . " artifact_quality_" . strtolower($artifact->quality_name) . " artifact_original_quality_" . strtolower($artifact->original_quality_name) . " '>\n";
            $background = "";
            $icon = "";
            if ($artifact->type == ARTIFACT_TYPE::ARCHETYPE){
                $background = URL::IMG["ARTIFACT"] . "type_" . strtolower($artifact->quality_name) . ".png";
                $icon = URL::IMG["ARTIFACT"] . "type_";
                switch ($artifact->type){
                    case ARCHETYPE_ID::ATTACK:
                        $icon .= "attack";
                        break;
                    case ARCHETYPE_ID::DEFENSE:
                        $icon .= "defense";
                        break;
                    case ARCHETYPE_ID::HP:
                        $icon .= "hp";
                        break;
                    case ARCHETYPE_ID::SUPPORT:
                        $icon .= "support";
                        break;
                }
                $icon .= ".png";
            }
            else{
                $background = URL::IMG["ARTIFACT"] . "element_" . strtolower($artifact->quality_name) . ".png";
                $icon = URL::IMG["ARTIFACT"] . "element_";
                switch ($artifact->element){
                    case ELEMENT_ID::WATER:
                        $icon .= "water";
                        break;
                    case ELEMENT_ID::WIND:
                        $icon .= "wind";
                        break;
                    case ELEMENT_ID::FIRE:
                        $icon .= "fire";
                        break;
                    case ELEMENT_ID::LIGHT:
                        $icon .= "light";
                        break;
                    case ELEMENT_ID::DARK:
                        $icon .= "dark";
                        break;
                }
                $icon .= ".png";
            }
            $html .= "<img class='artifact_base' src='" . $background . "'/>\n";
            $html .= "<img class='artifact_icon' src='" . $icon . "'/>\n";
            $html .= "<span class='artifact_stars'>\n";
            $html .= "</span>\n";
            $html .= "<span class='artifact_level'>\n";
            $html .= $artifact->level . "\n";
            $html .= "</span>\n";
            $html .= "</div>\n";
            if ($unit instanceof Unit){
                $html .= "<div class='assigned'>\n";
                $html .= "<a target='blank' href='/monsters/" . $unit->id . "'>\n";
                $html .= "<img title='" . $unit->title . "' class='monster_image border_" . $unit->unit->element_name . "' src='" . $unit->unit->get_image() . "'/>\n";
                $html .= "</a>\n";
                $html .= "</div>\n";
            }
            return $html;
        }

        /**
         * Generates a artifact table.
         * 
         * @param Artifact artifact Entity to get the info from.
         * @param Unit unit Optional. The unit the artifact is assigned to.
         * @return string HTML content for a artifact table. Empty on error.
         */
        public static function artifact_table($artifact, $unit = null) {
            if (!($artifact instanceof Artifact)){
                return "";
            }
            $html = "";
            $html .= "<table class='artifact' id='artifact-" . $artifact->id . "'>\n";
            $html .= "<tr>\n";
            $html .= "<td class='icon'>\n";
            $html .= HTML::artifact_panel($artifact, $unit) . "\n";
            $html .= "</td>\n";
            $html .= "<td class='effects'>\n";
            $html .= "<table>\n";
            // Main stat
            $html .= "<tr class='effect main_stat'>\n";
            $html .= "<td class='effect'>\n";
            $stat_name = $artifact->main_stat_name;
            $stat_value = "+ " . $artifact->main_stat_value;
            $html .= $stat_name . "\n";
            $html .= $stat_value . "\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $effects = array($artifact->effect_1_description, $artifact->effect_2_description, $artifact->effect_3_description, $artifact->effect_4_description);
            for ($i = 0; $i < 4; $i ++){
                $html .= "<tr class='effect'>\n";
                $html .= "<td class='effect'>\n";
                $html .= $effects[$i];
                $html .= "</td>\n";
                $html .= "</tr>\n";
            }
            $html .= "</table>\n";
            $html .= "</td>\n";
            // Details
            /* TODO: Only quaity data, and for that the icon is enough
            $html .= "<td class='details'>\n";
            $html .= "<table class='table_details'>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Quality:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= "<span class='quality quality_" . strtolower($artifact->quality_name) . "'>\n";
            $html .= $artifact->quality_name . "\n";
            $html .= "</span>\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            $html .= "Original q.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            $html .= "<span class='quality quality_" . strtolower($artifact->original_quality_name) . "'>\n";
            $html .= $artifact->original_quality_name . "\n";
            $html .= "</span>\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            // TODO: No data on value yet
            $html .= ""; //"Value:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            // TODO: No data on value yet
            $html .= ""; //number_format($artifact->value, 0, ".", ",") . "\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //"Efficiency:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //number_format($artifact->efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //"Max. eff.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //number_format($artifact->max_efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "<tr>\n";
            $html .= "<td class='title'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //"Reached. eff.:\n";
            $html .= "</td>\n";
            $html .= "<td class='value'>\n";
            // TODO: No data on efficiencies yet
            $html .= ""; //number_format($artifact->efficiency * 100 / $artifact->max_efficiency, 2, ".", ",") . "%\n";
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "</table>\n";
            */
            $html .= "</td>\n";
            $html .= "</tr>\n";
            $html .= "</table>\n";
            return $html;
        }

        /**
         * Generates a grindstone or gem panel.
         * 
         * @param Rune_Craft craft Entity to get the info from.
         * @return string HTML content for a rune panel. Empty on error.
         */
        public static function craft_panel($craft) {
            if (!($craft instanceof Rune_Craft)){
                return "";
            }
            $html = "";
            if ($craft->gem == 1){
                if ($craft->inmemorial == 1){
                    $base = URL::IMG["GRIND"] . "gem_inmemorial.png";
                }
                else{
                    $base = URL::IMG["GRIND"] . "gem.png";
                }
            }
            else{
                if ($craft->inmemorial == 1){
                    $base = URL::IMG["GRIND"] . "grind_inmemorial.png";
                }
                else{
                    $base = URL::IMG["GRIND"] . "grind.png";
                }
            }
            if ($craft->inmemorial == 0 && isset($craft->rune)){
                $icon = "<img class='craft_icon' src='" . $craft->rune->get_image() . "'/>\n";
            }
            else{
                $icon = "";
            }
            if (in_array($craft->stat_name, array("CRR", "CRD", "RES", "ACC", "HP%", "ATK%", "DEF%"))){
                $stat_name = str_replace("%", "", $craft->stat_name);
                $stat_value = "+ " . $craft->min . "~" . $craft->max . "%";
            }
            else{
                $stat_name = $craft->stat_name;
                $stat_value = "+ " . $craft->min . "~" . $craft->max;
            }
            $html .= "<div class='craft_panel craft_quality_" . strtolower($craft->quality_name) . " rune_ancient_" . $craft->ancient . "'>\n";
            $html .= "<img class='craft_base' src='" . $base . "'/>\n";
            $html .= $icon;
            $html .= "<span class='craft_stat'>\n";
            $html .= "<span class='craft_stat_name'>" . $stat_name . "</span>\n";
            $html .= "<span class='craft_stat_value'>" . $stat_value . "</span>\n";
            $html .= "</span>\n";
            $html .= "<span class='craft_amount'>\n";
            $html .= "x" . $craft->amount . "\n";
            $html .= "</span>\n";
            $html .= "</div>\n";
            return $html;
        }

        /**
         * Generates a building panel.
         *
         * @param Building|Decoration|K_Building|K_Decoration $building Entity to get the info from.
         * @return string HTML content for a building panel. Empty on error.
         */
        public static function building_panel($building) {
            if ($building instanceof Building){
                $level = false;
                $title = $building->building->name;
                $description = $building->building->description;
                $img = $building->building->get_image();
            }
            elseif ($building instanceof K_Building){
                $level = false;
                $title = $building->name;
                $description = $building->building->description;
                $img = $building->get_image();
            }
            elseif ($building instanceof Decoration){
                $level = $building->level;
                $title = $building->decoration->name;
                $description = $building->decoration->description;
                $img = $building->decoration->get_image();
            }
            elseif ($building instanceof K_Decoration){
                $level = false;
                $title = $building->name;
                $description = $building->building->description;
                $img = $building->get_image();
            }
            else{
                return "";
            }
            if (strlen($description) > 0){
                $title .= ": " . $description;
            }
            $html = "";
            $html = "<div class='building_panel'>\n";
            $html .= "<img title='" . $title . "' class='building' src='" . $img . "'/>\n";
            if ($level){
                $html .= "<span class='level'>\n";
                $html .= $level . "\n";
                $html .= "</span>\n";
            }
            $html .= "</div>\n";
            return $html;
        }

        /**
         * Generates a item panel.
         *
         * @param Inventory $item Entity to get the info from.
         * @return string HTML content for a building panel. Empty on error.
         */
        public static function item_panel($item) {
            if (!($item instanceof Inventory)){
                return "";
            }
            $html = "";
            $html = "<div class='item_panel'>\n";
            $html .= "<img title='" . $item->name . "' class='item' src='" . $item->get_image() . "'/>\n";
            $html .= "<span class='amount'>\n";
            $html .= $item->amount . "\n";
            $html .= "</span>\n";
            $html .= "</div>\n";
            return $html;
        }
    }

?>