pr2/SInput.php5

<?php

/* ------------------------------------------------------ */
/* SInput
/* ------------------------------------------------------ */
/* Author: jwsm@shodor.org
/* Date: last updated 5/27/07
/* Description: SInput is an object representing an input
/* "event" as content is loaded into a PR2 page. The input
/* object holds not only the input, but preferences about
/* how that input should be handled. The SInput object kicks
/* off a translation of the input using the proper
/* translator class.
/* ------------------------------------------------------ */

class SInput extends SObject
{
    protected $source;
    protected $xmlObj;
    protected $options;
    protected $parent;
    protected $name;

    public function doc() {
        return "An instance of SInput is generated each time you load"
                . " content into PageRender2."
                . " Each input object has an identifying name"
                . " and provides source and options to a translator.";
    }

    public function __construct ($source, $options, $parent = array(), $name = "")
    {
        $this->source = $source;
        $this->options = $options;
        $this->parent = $parent;
        $this->name = $name;
    }

    public function getXmlObj ()
    {   return $this->xmlObj;   }

    public function getSource ()
    {   return $this->source; }

    public function setSource ($source)
    {   $this->source = $source; }

    public function getName ()
    {   return $this->name; }

    public function translate () {
        // don't translate if there are already errors set on this object
        if ($this->hasError()) {
            $this->setPrettyError('translate', "can't translate an input with previously logged errors.");
            return false;
        }

        // get the name of the translation class; load the file describing the class
        $trans_class = $this->getOption('translator_' . $this->getOption('inFormat'));
        //loadTranslate($trans_class);
        $translator = $this->parent->getClassInstance($trans_class);

        // check to make sure that a class instance of the translator exists;
        if ($translator === false) {
            $this->setPrettyError('translate', "Can't initiate translate: translation class not found.");
            return false;
        }

        // check to make sure that input format for translator is the format we are giving it
        if ($translator->getInFormat() != $this->getOption('inFormat')) {
            $this->setError("Format mismatch: translator $trans_class input format (" . $translator->getInFormat()
                            . ") does not match requested input format (" . $this->getOption('inFormat') . ")."
                            . " Either the translator is incorrectly named, or it has not properly declared"
                            . " its input/output types.");
            return false;
        }

        // check to make sure that output format for translator matches the target page format
        if ($translator->getOutFormat() != $this->parent->getPage()->getFormat()) {
            $this->setError("Format mismatch: translator $trans_class output format (" . $translator->getOutFormat()
                            . ") does not match page output format (" . $this->parent->getPage()->getFormat() . ")."
                            . " Either the translator is incorrectly named, or it has not properly declared"
                            . " its input/output types.");
            return false;
        }

        // set the input options from SInput onto the translator object
        // so that they are accessible from extended translator classes.
        $translator->setInputOptions($this->options);

        // do the actual translation
        $result = $translator->translate($this);

        // propagate warnings from the translator object to this object
        $this->getWarningFrom($translator);

        // if there is an error translating, propagate the errors and return false
        if ($result === false || $translator->hasError()) {
            $this->setPrettyError('translate', "there was an error translating the input using "
                                    . get_class($translator) . ".");
            $this->setError($translator->getError());
            $translator->resetError();
            $translator->resetWarning();
            return false;
        }

        return true;
    }

    /*--------------------------------------------------------------------------------*/
    /* Set/Get and Task Functions */

    public function sendError ($errArr)
    {   $this->parent->sendError('SInput', $this->name, $errArr); }

    public function getOption ($key)
    {   if (isset($this->options[$key])) {return $this->options[$key];}
        else return $this->parent->getDefault($key);
    }

    public function getDefault ($key)
    {   return $this->parent->getDefault($key); }

    public function getPageRender() {
        return $this->parent;
    }
}



?>

---