pr2/translate/STransStdXMLHelper.php5

<?php
class STransStdXMLHelper
{
    protected $parent;
    protected $translator;

    public function doc() {
        return "STransStdXMLHelper is a class that helps STransStdXML"
                . " perform its translation.";
    }

    function __construct ($parent)
    {
        $this->parent = $parent;
    }

    // set which translator is the parent
    public function setTranslator($t) {
        $this->translator = $t;
    }

    public function getTranslator() {
        return $t;
    }

    public function formatSectionHtml($section)
    {
        $htmlOutput = "<div class=\"section\">";
        if (isset($section->name)){
            $htmlOutput .= "<div class=\"sectionName\">" . $section->name . "</div>";
        }
        if (isset($section->block)){
            foreach ($section->block as $currentBlock) {
                $htmlOutput .= "<div class=\"block\" ";
                if (isset($currentBlock['align'])){
                    $htmlOutput .= "align=\"" . $currentBlock['align'] . "\" ";
                }
                $htmlOutput .= ">";
                $htmlOutput .= $this->formatBlockHtml($currentBlock) . "</div>";
            }
        }
        $htmlOutput .= "</div>";
        return $htmlOutput;
    }

    public function formatTextHtml($text)
    {
        $htmlOutput = "<div class=\"text\" ";

        if (isset($text['align'])){
            $alignment = $text['align'];
            if ($alignment == "indent")
            {
                $htmlOutput .= "style=\"padding-left:20px;\" ";
            } else {
                $htmlOutput .= "align=\"" . $alignment . "\" ";
            }
        }
        $htmlOutput .= ">";
        $htmlOutput .= $this->formatParagraphHtml($text) . "</div>";

        return $htmlOutput;
    }

    public function formatBlockHtml($block)
    {
        $htmlOutput = "";
        //decide whether the block will be treated
        //as standard block or as fancy block
        if (count($block->xpath('ul')) > 0 || count($block->xpath('ol')) > 0 || count($block->xpath('table')) > 0 || count($block->xpath('text')) > 0){
            // fancy block
            foreach ($block->children() as $tag => $child){
                switch($tag){
                    case 'ul':
                        $htmlOutput .=  $this->formatUl($child);
                        break;
                    case 'ol':
                        $htmlOutput .=  $this->formatOl($child);
                        break;
                    case 'table':
                        $htmlOutput .=  $this->formatTable($child);
                        break;
                    case 'text':
                        $htmlOutput .= $this->formatTextHtml($child);
                        break;
                    default:
                        break;
                }
            }
        } else {
            // standard block
            $htmlOutput .= $this->formatParagraphHtml($block);
        }
        return $htmlOutput;
    }

    public function formatUl($child)
    {
        $htmlOutput = "<ul>";
        foreach($child->li as $currentLi)
        {
            $htmlOutput .= "<li> " . $this->formatBlockHtml($currentLi) . "</li>";
        }
        $htmlOutput .= "</ul>";
        return $htmlOutput;
    }

    public function formatOl($child)
    {
        $htmlOutput = "<ol>";
        foreach($child->li as $currentLi)
        {
            $htmlOutput .= "<li> " . $this->formatBlockHtml($currentLi) . "</li>";
        }
        $htmlOutput .= "</ol>";
        return $htmlOutput;
    }

    public function formatTable($child)
    {
        $htmlOutput = "<table class=\"contentTable\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" >";
        foreach ($child->children() as $tag => $content){
            switch($tag){
                case 'tr':
                    $htmlOutput .= $this->formatTr($content);
                    break;
                case 'tbody':
                    $htmlOutput .= $this->formatTbody($content);
                    break;
                default:
                    break;
            }
        }
        $htmlOutput .= "</table>";
        return $htmlOutput;
    }

    public function formatTbody($child)
    {
        $htmlOutput = "<tbody>";
        foreach ($child->children() as $tag => $content){
            switch($tag){
                case 'tr':
                    $htmlOutput .= $this->formatTr($content);
                    break;
                default:
                    break;
            }
        }
        $htmlOutput .= "</tbody>";
        return $htmlOutput;
    }

    public function formatTr($child)
    {
        $htmlOutput = "<tr>";

        foreach ($child->children() as $tag => $content){
            switch($tag){
                case 'td':
                case 'th':

                    $attributes = "";
                    if (isset ($content['colspan']))
                    {
                        $attributes .= " colspan=\"" . $content['colspan'] . "\"";
                    }
                    $htmlOutput .= "<$tag$attributes> " . $this->formatBlockHtml($content) . "</$tag>";
                    break;
                default:
                    break;
            }
        }

        $htmlOutput .= "</tr>";
        return $htmlOutput;
    }


    /*  FUNCTION: formatParagraphHtml($paragraph)
        INPUT: a PHP object representing an XML tree of a paragraph tag, generated by simple_xml
        OUTPUT: this same paragraph, rendered in HTML
        USE: when rendering each paragraph in a page, call this function. This function
        can also be overloaded to create a specific paragraph "look" for a specific
        part of the site.
        */

    public function formatParagraphHtml($paragraph)
    {
/*      $htmlOutput = "<div class=\"paragraph\"";
        if ($paragraph['align'] == 'center'){$htmlOutput .= " align=\"center\"";}
        $htmlOutput .= ">";*/
        $htmlOutput = "";

        $parArray = $this->xmlToArray($paragraph->asXML());

        $numParts = count($parArray);
        for ($i=0; $i<$numParts; $i++)
        {
            switch($parArray[$i]['tag'])
            {
                case "BLOCK":
                case "TD":
                case "TH":
                case "LI":
                case "TEXT":
                case "TITLE":
                    $htmlOutput .= $this->formatParagraphTextHtml($parArray[$i]);
                    break;
                case "IMAGE":

                    $htmlOutput .= $this->formatParagraphImageHtml($parArray[$i]);
                    break;
                case "BOLD":
                case "B":
                    $htmlOutput .= $this->formatParagraphBoldHtml($parArray[$i]);
                    break;
                case "ITALIC":
                case "I":
                    $htmlOutput .= $this->formatParagraphItalicHtml($parArray[$i]);
                    break;
                case "U":
                    $htmlOutput .= $this->formatParagraphUnderlineHtml($parArray[$i]);
                    break;
                case "SUB":
                    $htmlOutput .= $this->formatParagraphSubHtml($parArray[$i]);
                    break;
                case "SUP":
                    $htmlOutput .= $this->formatParagraphSupHtml($parArray[$i]);
                    break;
                case "STRIKE":
                    $htmlOutput .= $this->formatParagraphStrikeHtml($parArray[$i]);
                    break;
                case "LINK":
                    $htmlOutput .= $this->formatParagraphLinkHtml($parArray[$i]);
                    break;
                case "BR":
                    $htmlOutput .= "<br />";
                    break;
                case "SPACE":
                    $htmlOutput .= "&nbsp;";
                    break;
                case "MULTISPACE":
                    $htmlOutput .= $this->formatMultispace($parArray[$i]);
                    break;
                case "TEXTCOLOR":
                case "COLOR":
                    $htmlOutput .= $this->formatParagraphTextColor($parArray[$i]);
                    break;
                case "LATEX":
                    $htmlOutput .= " <br />[[LaTEX Equation will appear here]]<br /> ";
                    break;
                case "MEDIA":
                    $htmlOutput .= $this->translateMedia($parArray[$i]);
                    break;
                case "CONTENT":
                    $htmlOutput .= $this->translateContent($parArray[$i]);
                    break;
                case 'ENTITY':
                    $htmlOutput .= '&' . (string)$parArray[$i]['value'] . ';';
                    break;
                default:
                    $htmlOutput .= $this->moreFormatOptions($parArray[$i]);
                    break;
            }
        }
        //$htmlOutput .= ("</div>\n");
        return ($htmlOutput);
    }

    public function translateMedia($partArray) {
        $snapid = $partArray['attributes']['SNAPID'];
        if(isset($partArray['attributes']['WHICH']))
            $which = $partArray['attributes']['WHICH'];
        else
            $which = "original";

        if(strpos($snapid, "/") !== false)
            $res = SnapResource::lookup($snapid);
        else {
            $res = SnapResource::retrieve($snapid);
        }

        if($res != null) {
            $version = $res->getActiveVersion();

            $html = $version->getContentModule()->retrieveContent(
                $version->getContent(), array('which' => $which));
        }
        else
            $html = false;

        if($html === false)
            $html = "<div style=\"padding: 4px; border: 1px solid black; "
                . "background-color: #E0E0E0; width: 8em; text-align: center;\">No Content</div>";

        return $html;
    }

    public function translateContent($partArray) {
        $snapid = $partArray['attributes']['SNAPID'];
        if(isset($partArray['attributes']['WHICH']))
            $which = $partArray['attributes']['WHICH'];
        else
            $which = "original";

        if(strpos($snapid, "/") !== false)
            $res = SnapResource::lookup($snapid);
        else {
            $res = new SnapResource($snapid);
            if(!$res->isValid())
                $res = null;
        }

        if($res != null) {
            $version = $res->getActiveVersion();

            $html = $version->getContentModule()->retrieveContent(
                $version->getContent(), array('which' => $which));
        }
        else
            $html = false;

        if($html === false)
            $html = "<div style=\"padding: 4px; border: 1px solid black; "
                . "background-color: #E0E0E0; width: 8em; text-align: center;\">No Content</div>";

        return $html;
    }


    /* extends the formatParagraphHtml switch statement for easy overriding */
    public function moreFormatOptions($partArray)
    {
            switch($partArray['tag'])
            {
                default:
                    return "";
                    break;
            }
    }

    /*  FUNCTION: formatParagraph__Html($partArray)
        INPUT: a PHP array representing an XML tree of some subsection of a
        paragraph, either content or an image or a styled section of text, etc.
        Each function has a specific type of subsection that it should render.
        OUTPUT: this same part of the paragraph, rendered in HTML
        USE: the paragraph renderer switches to call one of these methods as it
        processes the different components of a paragraph. This function
        can also be overloaded to create a specific "look" for a specific
        part of the site, i.e. if bold suddenly means something else, or if
        images come from a different base directory.
        */

    function formatMultispace($partArray)
    {
        $num = 10;
        $htmlOutput = "";
        if (isset($partArray['attributes']['NUMBER'])) $num = ($partArray['attributes']['NUMBER']);
        for ($n = 0; $n < $num; $n++)
        {
            $htmlOutput .= " &nbsp;";
        }
        return $htmlOutput;
    }

    function formatParagraphImageHtml($partArray)
    {
        $localImgDir = $this->parent->getPath('relLocalImgDirURL') . "/images";

        $width = ""; $height = "";
        $start = ""; $end = "";
        $alt = "";
        $path = "";
        $class = "";
        $format = "centered";
        if (isset($partArray['attributes']['ALT'])) $alt = ($partArray['attributes']['ALT']);
        if (isset($partArray['attributes']['PATH'])) $alt = ($partArray['attributes']['PATH']);
        if (isset($partArray['attributes']['WIDTH'])) $width = " width =\"" . ($partArray['attributes']['WIDTH']) . "\"";
        if (isset($partArray['attributes']['HEIGHT'])) $height = " height =\"" .  ($partArray['attributes']['HEIGHT']) . "\" ";
        if (isset($partArray['attributes']['CLASS'])) $class = ($partArray['attributes']['CLASS']);


        if (isset($partArray['attributes']['FORMAT'])){
            $format = $partArray['attributes']['FORMAT'];
        }
/*      switch($format){
            case 'inline':
                // start + end are blank
                break;
            case 'centered':
            default:
                // centered image by default
                $start = "<div class=\"centeredImage\" align=\"center\">";
                $end = "</div>";
                break;
        }*/

        if (isset($partArray['attributes']['TYPE']))
        {
            switch ($partArray['attributes']['TYPE']){
                case 'fullpath':
                    return ("$start<img class=\"$class\" src=\"" . $partArray['attributes']['NAME'] . "\" alt=\" \"". $width . $height . "/>$end");
                case 'localImg':
                case 'localimg':
                    return ("$start<img class=\"$class\" src=\"" . $localImgDir . "/" . $partArray['attributes']['NAME'] . "\" alt=\" \"". $width . $height . "/>$end");
                default;
                    break;
            }
        } else {
            return "<img />";
        }
    }

    public function formatStandardTag($openTag, $closeTag, $partArray)
    {
        $text = "";
        if (isset($partArray['value'])){ $text = $partArray['value'];}

        switch($partArray['type'])
        {
            case 'open':
                return $openTag . $text;
            case 'close':
                return $text . $closeTag;
            case 'complete':
                return $openTag . $text . $closeTag;
            case 'cdata':
                return $text;
            default:
                return "";
        }
    }

    public function formatParagraphTextHtml($partArray)
    {
        if (isset($partArray['value'])){
            return preg_replace('!<entity>([^<]+)</entity>!', '&$1;', $partArray['value']);
//          return (@$partArray['value']);
        }
    }

    public function formatParagraphBoldHtml($partArray)
    {
        $openTag = "<span class=\"bold\">";
        $closeTag = "</span>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphItalicHtml($partArray)
    {
        $openTag = "<span class=\"italic\">";
        $closeTag = "</span>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphUnderlineHtml($partArray)
    {
        $openTag = "<u>";
        $closeTag = "</u>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphSupHtml($partArray)
    {
        $openTag = "<sup>";
        $closeTag = "</sup>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphSubHtml($partArray)
    {
        $openTag = "<sub>";
        $closeTag = "</sub>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphStrikeHtml($partArray)
    {
        $openTag = "<strike>";
        $closeTag = "</strike>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    function formatParagraphTextColor($partArray)
    {
        $color = "black";
        if (isset($partArray['attributes']['COLOR'])) $color = ($partArray['attributes']['COLOR']);
        else if (isset($partArray['attributes']['VALUE'])) $color = ($partArray['attributes']['VALUE']);

        $openTag = "<span style=\"color:$color; font-wieght:bold;\">";
        $closeTag = "</span>";
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    public function formatParagraphLinkHtml($partArray)
    {
        $openTag = "<a href=\"#\">";
        $closeTag = "</a>";

        if ($partArray['type'] == 'open' || $partArray['type'] == 'complete')
        {
            if (isset($partArray['attributes']['ID'])){
                $name = $partArray['attributes']['ID'];
            } else {
                $name = "#";
            }

            if (isset($partArray['attributes']['TYPE']))
            {
                switch ($partArray['attributes']['TYPE']){
                    case 'hardLink':
                    case 'hardlink':
                    case 'fullpath':
                        $openTag = "<a href=\"" . $name . "\">";
                    default:
                        break;
                }
            }
        }
        return $this->formatStandardTag($openTag, $closeTag, $partArray);
    }

    protected function xmlToArray($contents) {
       $xml_parser = xml_parser_create();
       xml_parse_into_struct($xml_parser, $contents, $ret_arr);
       xml_parser_free($xml_parser);
       return $ret_arr;
    }

}

?>

---