snap2/content/SnapContentInteractivateLesson.php5

<?php

class SnapContentInteractivateLesson extends SnapContent {
    protected $NEED_TRANSLATION = true;

    protected $currentXML = null;
    protected $loadErrors = array();

    protected function prepareAndValidateXML($content, $field, $pre = '', $post = '') {
        $content = ltrim(rtrim($content));
        $pre = '<XMLResource><section>' . $pre;
        $post = $post . '</section></XMLResource>';
        $res = XmlFormatter::prepareXML($content, $field, true);
        if(is_array($res)) {
            $this->loadErrors = array_merge($this->loadErrors, $res);
            return false;
        }
        $res = SXMLHelper::validateXML($in = "$pre$content$post", true);
        if(is_array($res)) {
            $res = XmlFormatter::prepareXML($content, $field, false);
            $res = SXMLHelper::validateXML($in = "$pre$content$post", true);
        }
        if(is_array($res)) {
            foreach($res as $err)
                $this->loadErrors[] = "In field <b>$field</b>: $err";
            return false;
        }
        $ret = SXMLHelper::formatXML($content);
        if(!$ret)
            $ret = $content;
        return $ret;
    }

    public function setTitle($title) {
        $this->set('title', $title);
    }

    public function setAbstract($abstract) {
        $abstract = $this->prepareAndValidateXML($abstract, 'Abstract');
        if($abstract === false)
            return false;
        else
            $this->set('abstract', $abstract);
    }

    public function clearObjectives() {
        $this->set('objectives', array());
    }

    public function addObjective($obj) {
        $obj = $this->prepareAndValidateXML($obj, 'Objective', '<ul><li>', '</li></ul>');
        if($obj === false)
            return false;
        $objectives = $this->get('objectives');
        if(!is_array($objectives))
            $objectives = array($obj);
        else
            $objectives[] = $obj;
        $this->set('objectives', $objectives);
    }

    public function clearPrerequisites() {
        $this->set('prereqs', array());
    }

    public function addPrerequisiteCategory($cat) {
        $cat = ltrim(rtrim($cat));
        $cat = $this->prepareAndValidateXML($cat, 'Prerequisite Category', '<ul><li>', '</li></ul>');
        if($cat === false)
            return false;
        $prereqs = $this->get('prereqs');
        if(!is_array($prereqs))
            $prereqs = array($cat => array());
        else if(!isset($prereqs[$cat]) || !is_array($prereqs[$cat]))
            $prereqs[$cat] = array();
        $this->set('prereqs', $prereqs);
        return true;
    }

    public function addPrerequisite($cat, $pre) {
        $cat = ltrim(rtrim($cat));
        $pre = ltrim(rtrim($pre));
        $pre = $this->prepareAndValidateXML($pre, 'Prerequisite', '<ul><li>', '</li></ul>');
        if($pre === false)
            return false;
        $cat = $this->prepareAndValidateXML($cat, 'Prerequisite Category', '<ul><li>', '</li></ul>');
        if($cat === false)
            return false;
        $prereqs = $this->get('prereqs');
        if(!is_array($prereqs))
            $prereqs = array($cat => array($pre));
        else if(!isset($prereqs[$cat]))
            $prereqs[$cat] = array($pre);
        else
            $prereqs[$cat][] = $pre;
        $this->set('prereqs', $prereqs);
        return true;
    }

    public function setPreparations($content) {
        $content = $this->prepareAndValidateXML($content, 'Teacher Preparations');
        if($content === false)
            return false;
        else
            $this->set('preps', $content);
        return true;
    }

    public function clearKeyTerms() {
        $this->set('keyTerms', array());
    }

    public function addKeyTerm($term) {
        $word = new TSDWord($term);
        if($word->definition == '') {
            $this->loadErrors[] = "<b>Key Term</b> '$term' is not a valid key term";
            return false;
        }
        $keyTerms = $this->get('keyTerms');
        if(!is_array($keyTerms))
            $keyTerms = array($term);
        else
            $keyTerms[] = $term;
        $this->set('keyTerms', $keyTerms);
        return true;
    }

    public function clearSections() {
        $this->set('sections', array());
    }

    // content is lessonplan style pseudo-XML
    public function addSection($name, $content) {
        $name = $this->prepareAndValidateXML($name, 'Section Name', '<p><span>', '</span></p>');
        if($name === false)
            return false;
        $content = $this->prepareAndValidateXML($content, "Section '$name'");
        if($content === false)
            return false;
        $sections = $this->get('sections');
        if(!is_array($sections))
            $sections = array($name => $content);
        else
            $sections[$name] = $content;
        $this->set('sections', $sections);
        return true;
    }

    public function setAlternate($content) {
        $content = $this->prepareAndValidateXML($content, 'Alternate Outline');
        if($content === false)
            return false;
        $this->set('alternate', $content);
        return true;
    }

    public function clearFollowUps() {
        $this->set('followUp', array());
    }

    public function setFollowUpIntro($content) {
        $content = $this->prepareAndValidateXML($content, 'Follow Up Intro');
        if($content === false)
            return false;
        $this->set('followUpIntro', $content);
        return true;
    }

    public function addFollowUp($content) {
        $content = $this->prepareAndValidateXML($content, 'Follow Up', '<ul><li>', '</li></ul>');
        if($content === false)
            return false;
        $followUp = $this->get('followUp');
        $followUp[] = $content;
        $this->set('followUp', $followUp);
        return true;
    }

    private function grabBlockSection($xml, $xpath, $trimTag = 'p') {
        $xpath .= '/' . $trimTag;
        $sectionXML = $xml->xpath($xpath);
        if(!$sectionXML)
            return '';
        $section = '';
        foreach($sectionXML as $p) {
            if($trimTag != '')
                $section .= trim(substr($p->asXML(), strlen($trimTag) + 2, -(strlen($trimTag) + 3)));
            else
                $section .= trim($p->asXML());
        }
        return $section;
    }

    private function grabListItems($xml, $xpath) {
        $items = $xml->xpath($xpath);
        if(!$items)
            return array();
        $ret = array();
        foreach($items as $item) {
            $ret[] = trim(substr($item->asXML(), 4, -5));
        }
        return $ret;
    }

    public function loadFromXML($content) {
        $xml = simplexml_load_string($content);

        $title = $xml->xpath('/XMLResource/section[@mapping="title"]/name');
        if($title)
            $title = (string)$title[0];
        else
            $title = '';

        $abstract = $this->grabBlockSection($xml, '/XMLResource/section[@mapping="abstract"]');

        $objectives = $this->grabListItems($xml, '/XMLResource/section[@mapping="objectives"]/p/ul/li');

        $prereqXML = $xml->xpath('/XMLResource/section[@mapping="prerequisites"]/p/ul/li');
        $prereqs = array();
        if($prereqXML)
            foreach($prereqXML as $p) {
                $cat = trim(preg_replace('/^\s*<li>(.*)<ul>.*<\/ul>\s*<\/li>\s*$/ms', '$1', $p->asXML()));
                $prereqs[$cat] = array();
                $items = $this->grabListItems($p, '*/li');
                foreach($items as $item)
                    $prereqs[$cat][] = $item;
            }

        $kts = $xml->xpath('/XMLResource/section[@mapping="keyTerms"]/resourceData/word');
        $keyTerms = array();
        if($kts)
            foreach($kts as $k) {
                $keyTerms[] = trim((string)$k);
            }

        $sects = $xml->xpath('/XMLResource/section[@mapping="outline"]/section[@mapping="section"]');
        $sections = array();
        if($sects)
            foreach($sects as $sect) {
                $name = trim((string)$sect->resourceData->name);
                $content = $this->grabBlockSection($sect, 'section[@mapping="content"]');
                $sections[$name] = $content;
            }

        $teacherPrep = $this->grabBlockSection($xml, '/XMLResource/section[@mapping="teacherPreparations"]');

        $alternate = $this->grabBlockSection($xml, '/XMLResource/section[@mapping="alternateOutline"]');

        $followupintro = $xml->xpath('/XMLResource/section[@mapping="followUp"]/p');
        if($followupintro) {
            $cnt = 0;
            foreach($followupintro as $foo)
                $cnt++;
            if($cnt > 1) {
                $followUpBlock = $followupintro[$cnt - 1];
                $fui = '';
                for($i = 0; $i < $cnt - 1; $i++) {
                    $fui .= (string)$followupintro[$i]->asXML();
                }
                $followupintro = trim(substr($fui, 3, -4));
            }
            else
                $followUpBlock = $xml->xpath('/XMLResource/section[@mapping="followUp"]/p');
            $followups = $this->grabListItems($followUpBlock, 'ul/li');
        }
        else {
            $followupintro = '';
            $followups = array();
        }

        $this->setTitle($title);
        $this->setAbstract($abstract);
        foreach($objectives as $obj)
            $this->addObjective($obj);
        foreach($prereqs as $cat => $pres) {
            $this->addPrerequisiteCategory($cat);
            foreach($pres as $pre)
                $this->addPrerequisite($cat, $pre);
        }
        foreach($keyTerms as $kt)
            $this->addKeyTerm($kt);
        foreach($sections as $name => $content)
            $this->addSection($name, $content);
        $this->setPreparations($teacherPrep);
        $this->setAlternate($alternate);
        $this->setFollowUpIntro($followupintro);
        foreach($followups as $fu)
            $this->addFollowUp($fu);
    }

    public function getXML() {
        if(!$this->currentXML) {
            $ret = $this->generateXML();
            if(is_array($ret)) {
                foreach($ret as $entry)
                    $this->setError($entry);
                return false;
            }
            $this->currentXML = $ret;
        }

        return $this->currentXML;
    }

    protected function generateXML() {
        $errors = array();

        $title = trim($this->get('title'));
        $abstract = trim($this->prepareAndValidateXML($this->get('abstract'), 'Abstract'));
        $objectives = (is_array($this->get('objectives')) ? $this->get('objectives') : array());
        $prereqs = (is_array($this->get('prereqs')) ? $this->get('prereqs') : array());
        $preps = trim($this->prepareAndValidateXML($this->get('preps'), 'Teacher Preparation'));
        $keyTerms = (is_array($this->get('keyTerms')) ? $this->get('keyTerms') : array());
        $sections = (is_array($this->get('sections')) ? $this->get('sections') : array());
        $alternate = trim($this->prepareAndValidateXML($this->get('alternate'), 'Alternate Outline'));
        $followUp = (is_array($this->get('followUp')) ? $this->get('followUp') : array());
        $fuIntro = trim($this->prepareAndValidateXML($this->get('followUpIntro'), 'Follow Up Intro'));

        $sectionStr = '';
        foreach($sections as $nm => $sect) {
            $ret = $this->prepareAndValidateXML($sect, $nm);
            if(is_array($ret))
                $errors = array_merge($errors, $ret);
            else {
                $sectionStr .= '<section mapping="section"><resourceData><name>' . htmlspecialchars($nm)
                    . '</name></resourceData><section mapping="content">' . $ret . '</section></section>';
            }
        }
        if(count($sections) > 0)
            $sectionStr = "<section mapping=\"outline\">$sectionStr</section>";

        $objStr = '';
        foreach($objectives as $obj)
            $objStr .= '<li>' . htmlspecialchars($obj) . '</li>';
        if(count($objectives) > 0)
            $objStr = <<<END_XML
<section mapping="objectives">
    <p>Upon completion of this lesson, students will:
        <ul>$objStr</ul>
    </p>
</section>

END_XML;

        $preStr = '';
        foreach($prereqs as $cat => $ps) {
            $preStr .= '<li>' . $cat . (substr($cat, -1) == ':' ? '' : ':');
            if(count($ps) > 0) {
                $preStr .= '<ul>';
                foreach($ps as $pre)
                    $preStr .= '<li>' . $pre . '</li>';
                $preStr .= '</ul>';
            }
            $preStr .= '</li>';
        }
        if(count($prereqs) > 0)
            $preStr = "<section mapping=\"prerequisites\"><ul>$preStr</ul></section>";

        $ktStr = '';
        foreach($keyTerms as $term)
            $ktStr .= '<word>' . htmlspecialchars($term) . '</word>';
        if(count($keyTerms) > 0)
            $ktStr = "<section mapping=\"keyTerms\"><resourceData>$ktStr</resourceData></section>";

        $fuStr = '';
        foreach($followUp as $fu) {
            $ret = $this->prepareAndValidateXML($fu, 'Suggested Follow-up');
            if(is_array($ret))
                $errors = array_merge($errors, $ret);
            else
                $fuStr .= '<li>' . $ret . '</li>';
        }

        if(count($followUp) > 0)
            $fuStr = '<section mapping="followUp">' . $fuIntro . '<ul>' . $fuStr . '</ul></section>';
        else if($fuIntro != '')
            $fuStr = '<section mapping="followUp">' . $fuIntro . '</section>';

        if($abstract != '')
            $abstract = "<section mapping=\"abstract\">$abstract</section>";
        if($alternate != '')
            $alternate = "<section mapping=\"alternateOutline\">$alternate</section>";

        if($preps != '')
            $preps = "<section mapping=\"teacherPreparations\">$preps</section>";

        if(count($errors) > 0)
            return $errors;

        $xmlString = <<<END_XML
<XMLResource>
    <section mapping="title">
        <name>$title</name>
    </section>
    $abstract
    $objStr
    <section mapping="standards">
        <p>{{{PLACEHOLDER}}}</p>
    </section>
    <section mapping="textbooks">
        <p>{{{PLACEHOLDER}}}</p>
    </section>
    $preStr
    $preps
    $ktStr
    $sectionStr
    $alternate
    $fuStr
</XMLResource>
END_XML;

    //  print "Whats been generated: <pre>" . htmlspecialchars($xmlString) . '</pre>';

        $ret = XmlFormatter::finalGenerateXML($xmlString, true);

        return $ret;
    }

    public function getTitle() {
        return $this->get('title');
    }

    public function getAbstract() {
        return $this->get('abstract');
    }

    public function getObjectives() {
        $o = $this->get('objectives');
        return is_array($o) ? $o : array();
    }

    public function getPrerequisites() {
        $o = $this->get('prereqs');
        return is_array($o) ? $o : array();
    }

    public function getPreparations() {
        return $this->get('preps');
    }

    public function getKeyTerms() {
        $o = $this->get('keyTerms');
        return is_array($o) ? $o : array();
    }

    public function getSections() {
        $o = $this->get('sections');
        return is_array($o) ? $o : array();
    }

    public function getAlternate() {
        return $this->get('alternate');
    }

    public function getFollowUps() {
        $o = $this->get('followUp');
        return is_array($o) ? $o : array();
    }

    public function getFollowUpIntro() {
        return $this->get('followUpIntro');
    }

    public function getLoadErrors() {
        return $this->loadErrors;
    }

    protected function validate() {
        return true;
    }

    protected function doGetHTML($params) {
        return $this->getAll();
    }

    public function checkMedia() {
        return true;
    }

    public function updateFileList() {
        return true;
    }

    public static function initialValue() {
        return "<XMLResource>\n</XMLResource>\n";
    }
}

?>

---