1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 

<?php namespace Nethgui\Renderer;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Enanches the abstract renderer with the wiget factory interface
 *
 * Fragments of the view string representation can be generated through the widget objects
 * returned by the factory interface.
 *
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 * @api
 */
class Xhtml extends \Nethgui\Renderer\TemplateRenderer implements \Nethgui\Renderer\WidgetFactoryInterface, \Nethgui\Component\DependencyInjectorAggregate
{
    /**
     *
     * @var integer
     */
    private $inheritFlags = 0;
    private $requireFlags = 0;
    private $rejectFlags = 0;

    /**
     *
     * @var \Nethgui\Model\StaticFiles
     */
    protected $staticFiles;

    public function __construct(\Nethgui\View\ViewInterface $view, $templateResolver, $inheritFlags)
    {
        parent::__construct($view, $templateResolver, 'text/html', 'UTF-8');
        $this->inheritFlags = $inheritFlags & NETHGUI_INHERITABLE_FLAGS;
    }

    /**
     * 
     * @api
     * @param \Nethgui\View\ViewInterface $view
     * @return \Nethgui\Renderer\Xhtml
     */
    public function spawnRenderer(\Nethgui\View\ViewInterface $view)
    {
        $renderer = new self($view, $this->getTemplateResolver(), $this->getDefaultFlags());
        call_user_func($this->di, $renderer);
        $renderer->httpResponse = $this->httpResponse;
        $renderer->staticFiles = $this->staticFiles;
        return $renderer;
    }

    protected function createWidget($widgetType, $attributes = array())
    {
        $className = 'Nethgui\Widget\Xhtml\\' . ucfirst($widgetType);

        $o = new $className($this);
        call_user_func($this->di, $o);

        foreach ($attributes as $aname => $avalue) {
            $o->setAttribute($aname, $avalue);
        }

        return $o;
    }

    /**
     * Append a Javascript code fragment to the global .js temporary file
     * 
     * @api
     * @param string $jsCode Raw Javascript code
     * @return Xhtml
     */
    public function includeJavascript($jsCode)
    {
        if ($this->staticFiles === NULL) {
            $this->getLog()->warning(sprintf("%s::%s() NULL Resource handler", __CLASS__, __FUNCTION__));
            return;
        }
        $this->staticFiles->appendCode($jsCode, 'js');
        return $this;
    }

    /**
     * Append a CSS code fragment to the global .css temporary file
     *
     * @api
     * @param string $cssCode Raw Css code
     * @return Xhtml
     */
    public function includeCss($cssCode)
    {
        if ($this->staticFiles === NULL) {
            $this->getLog()->warning(sprintf("%s::%s() NULL Resource handler", __CLASS__, __FUNCTION__));
            return;
        }
        $this->staticFiles->appendCode($cssCode, 'css');
        return $this;
    }

    /**
     * Append the given file to a global temporary file with the same extension.
     *
     * The file path is relative to the <namespace>/Resource/ directory. The
     * <namespace> is assumed to be the same of the module.
     * 
     * @api
     * @param string $fileName
     * @return Xhtml
     */
    public function includeFile($fileName)
    {
        if ($this->staticFiles === NULL) {
            $this->getLog()->warning(sprintf("%s::%s() NULL Resource handler", __CLASS__, __FUNCTION__));
            return;
        }
        $filePath = call_user_func($this->getTemplateResolver(), $fileName);
        $this->staticFiles->includeFile($filePath);
        return $this;
    }

    /**
     * Transfer the given translation strings to the javascript environment.
     *
     * @see $.Nethgui.Translator in jquery.nethgui.base.js
     * 
     * @param array|Traversable $keys
     * @return Xhtml
     */
    public function includeTranslations($keys)
    {
        $out = array();

        foreach ($keys as $key) {
            $out[$key] = $this->view->translate($key);
        }

        $this->includeJavascript('
// Translations from ' . $this->view->getClientEventTarget('') . '
(function ($) {
 $.Nethgui.Translator.extendCatalog(' . json_encode($out) . ');
} ( jQuery ));
');

        return $this;
    }

    /**
     * $flag bits are ORed on the widget that include this view.
     * 
     * @api
     * @param integer $flags
     * @return \Nethgui\Renderer\Xhtml 
     */
    public function requireFlag($flags)
    {
        $this->requireFlags |= $flags;
        return $this;
    }

    /**
     * $flag bits are masked on the widget that include this view.
     * 
     * @see requireFlag()
     * @api
     * @param integer $flags
     * @return \Nethgui\Renderer\Xhtml 
     */
    public function rejectFlag($flags)
    {
        $this->rejectFlags |= $flags;
        return $this;
    }

    /**
     * Calculate flags for view inclusion
     * @see \Nethgui\Widget\Xhtml\Inset
     * @param integer $widgetFlags
     */
    public function calculateIncludeFlags($widgetFlags)
    {
        return ($widgetFlags | $this->requireFlags) & (~ $this->rejectFlags);
    }

    /**
     * Link an external file into the final XHTML document
     *
     * The XHTML tag generated depends on the file extension. Javascript (.js)
     * needs the SCRIPT tag, External stylesheets (.css) a LINK tag.
     * 
     * @api
     * @param string $fileName
     * @return Xhtml
     */
    public function useFile($fileName)
    {
        $this->staticFiles->useFile($this->getPathUrl() . $fileName);
        return $this;
    }

    public function getDefaultFlags()
    {
        return $this->inheritFlags;
    }

    public function setDefaultFlags($flags)
    {
        $this->inheritFlags = $flags;
        return $this;
    }

    public function elementList($flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('flags' => $flags));
    }

    public function buttonList($flags = 0)
    {
        $flags |= $this->inheritFlags;
        $widget = $this->createWidget("elementList", array('flags' => $flags));

        if ($flags & self::BUTTONSET) {
            $widget->setAttribute('class', 'Buttonset')
                ->setAttribute('wrap', 'div/. ');
        } else {
            $widget->setAttribute('class', 'Buttonlist')->setAttribute('wrap', 'div/. ');
        }

        // Automatically add standard submit/reset/cancel buttons:
        if ($flags & self::BUTTON_SUBMIT) {
            $widget->insert($this->button('Submit', self::BUTTON_SUBMIT));
        }
        if ($flags & self::BUTTON_RESET) {
            $widget->insert($this->button('Reset', self::BUTTON_RESET));
        }
        if ($flags & self::BUTTON_CANCEL) {
            $widget->insert($this->button('Cancel', self::BUTTON_CANCEL));
        }
        if ($flags & self::BUTTON_HELP) {
            $widget->insert($this->button('Help', self::BUTTON_HELP));
        }

        return $widget;
    }

    public function button($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function checkBox($name, $value, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'value' => $value, 'flags' => $flags));
    }

    public function fieldsetSwitch($name, $value, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'value' => $value, 'flags' => $flags));
    }

    public function form($flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('flags' => $flags));
    }

    public function hidden($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function inset($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function panel($flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('flags' => $flags));
    }

    public function radioButton($name, $value, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'value' => $value, 'flags' => $flags));
    }

    public function selector($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags, 'icon-before' => 'ui-icon-triangle-1-s'));
    }

    public function tabs($flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('flags' => $flags));
    }

    public function textInput($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function textLabel($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function fieldset($name = NULL, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        $widget = $this->createWidget(__FUNCTION__, array('flags' => $flags, 'icon-before' => 'ui-icon-triangle-1-s'));
        if ( ! is_null($name)) {
            $widget->setAttribute('name', $name);
        }
        return $widget;
    }

    public function header($name = NULL, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        $widget = $this->createWidget('textLabel', array('flags' => $flags, 'class' => 'header ui-widget-header ui-corner-all ui-helper-clearfix', 'tag' => 'h2'));
        if ( ! is_null($name)) {
            $widget->setAttribute('name', $name);
        }
        return $widget;
    }

    public function literal($data, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('data' => $data, 'flags' => $flags));
    }

    public function columns()
    {
        return $this->createWidget(__FUNCTION__, array());
    }

    public function progressBar($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function textArea($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function collectionEditor($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function console($name, $flags = 0)
    {
        $flags |= self::STATE_READONLY;
        $flags |= self::LABEL_NONE;
        return $this->textArea($name, $flags)->setAttribute('appendOnly', TRUE)->setAttribute('class', 'console');
    }

    public function dateInput($name, $flags = 0)
    {
        /*
         * Set to "be" (Big Endian) date format. Supported also "le" and "me".
         * see http://en.wikipedia.org/wiki/Calendar_date
         */
        return $this->textInput($name)->setAttribute('class', 'Date be');
    }

    public function timeInput($name, $flags = 0)
    {
        return $this->textInput($name)->setAttribute('class', 'Time');
    }

    public function objectPicker($name = NULL, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags, 'icon-before' => 'ui-icon-triangle-1-s'));
    }

    public function slider($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function textList($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function objectsCollection($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function fileUpload($name, $flags = 0)
    {
        $flags |= $this->inheritFlags;
        return $this->createWidget(__FUNCTION__, array('name' => $name, 'flags' => $flags));
    }

    public function getDependencySetters()
    {
        return array_merge(parent::getDependencySetters(), array('StaticFiles' => array($this, 'setStaticFilesModel')));
    }

    public function setStaticFilesModel(\Nethgui\Model\StaticFiles $model)
    {
        $this->staticFiles = $model;
        return $this;
    }

    public function setDependencyInjector($di)
    {
        $this->di = $di;
        return $this;
    }
}