pr2/translate/STrans.php5

<?php
class STrans extends SObject {
    protected $parent;
    protected $page;

    protected $transHelper;
    protected $transHelperClass = "";

    protected $transHelperCustom;
    protected $transHelperCustomClass = "";

    protected $options = array();
    protected $inputOptions = array();

    public function doc() {
        return "STrans is the parent translator class that all ther PR2"
                . " translators should extend.";
    }

    public function __construct ($parent) {
        $this->parent = $parent;
        $this->page = $parent->getPage();

        // if a translation helper class has been requested, get the instance from the parent
        // this way, we may be able to use an instance that's already been created
        if ($this->transHelperClass != "") {

            // instantiate the helper object, if there is one
            $helper = $this->parent->getClassInstance($this->transHelperClass);

            // report an error if there was an issue creating/fetching the instance
            if (!$helper){
                $this->setPrettyError("construct", "Can't retain a helper translator object. Object was not created.");
                return false;
            }

            // set our helper class to be the fetched instance
            $this->transHelper = $helper;
            $this->transHelper->setTranslator($this);
        }
    }


    /*-----------------------------------------------------*/
    /* Define a translator's input/output
    /*-----------------------------------------------------*/

    public function getInFormat() {
        return $this->getOption('inFormat');
    }

    public function getOutFormat() {
        return $this->getOption('outFormat');
    }


    /*-----------------------------------------------------*/
    /* Translate a given SInput object
    /*-----------------------------------------------------*/

    public function translate ($si)
    {
        /* override this function and put your translation code here */

        if ($this->hasError()) {
            $this->setPrettyError("translate",
                "This translator has logged errors; translation halted.");
            return false;
        }

        // if the trans_helper option is set, create a custom translator helper class
        // and store it with this translator
        if($si->getOption('trans_helper') != "") {
            // get the translation helper class name from the input
            $this->transHelperCustomClass = $si->getOption('trans_helper');

            // get an instance of the custom translation class
            $helper = $this->parent->getClassInstance($this->transHelperCustomClass);

            // report an error if there was an issue creating/fetching the instance
            if (!$helper){
                $this->setPrettyError("construct", "Can't retain a custom helper translator "
                        . "object. Object was not created.");
                return false;
            }

            // set the custom translator to be the translator we just created
            // from our custom-specified.
            $this->transHelperCustom = $helper;
            $this->transHelperCustom->setTranslator($this);
        }
        return true;
    }


    /*-----------------------------------------------------*/
    /* Helper Methods
    /*-----------------------------------------------------*/

    public function sendToTarget ($si, $input)
    {
        $target = $si->getOption('trans_target');
        $appendFn = ($si->getOption('trans_mode') == 'append') ? 'appendToSlot' : 'setSlot';
        $this->page->$appendFn($target, $input);
    }

    public function setOption ($key, $value)
    {   $this->options[$key] = $value; }

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

    public function setInputOptions($options) {
        $this->inputOptions = $options;
    }

    public function setInputOption ($key, $value)
    {   $this->inputOptions[$key] = $value; }

    function getInputOption($key)
    { if (isset($this->inputOptions[$key])) return $this->inputOptions[$key];
        else return null; }


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

?>

---