Create class documentation with latest phpdoc utility

Thomas Bruederli

2014-01-30 9ba4967a73a3d3db80af333a7d3d93e5a2c8bf79

 program/include/rcmail_output_html.php

@@ -5,7 +5,7 @@
 | program/include/rcmail_output_html.php                                |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2006-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2006-2013, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -23,7 +23,7 @@
/**
 * Class to create HTML page output using a skin template
 *
 * @package    Core
 * @package Webmail
 * @subpackage View
 */
class rcmail_output_html extends rcmail_output
@@ -83,9 +83,9 @@
        $this->set_env('skin', $skin);

        if (!empty($_REQUEST['_extwin']))
          $this->set_env('extwin', 1);
            $this->set_env('extwin', 1);
        if ($this->framed || !empty($_REQUEST['_framed']))
          $this->set_env('framed', 1);
            $this->set_env('framed', 1);

        // add common javascripts
        $this->add_script('var '.self::JS_OBJECT_NAME.' = new rcube_webmail();', 'head_top');
@@ -119,6 +119,7 @@
    public function set_env($name, $value, $addtojs = true)
    {
        $this->env[$name] = $value;

        if ($addtojs || isset($this->js_env[$name])) {
            $this->js_env[$name] = $value;
        }
@@ -662,23 +663,33 @@

        // add file modification timestamp
        if (preg_match('/\.(js|css)$/', $file, $m)) {
            $fs  = false;
            $ext = $m[1];

            // use minified file if exists (not in development mode)
            if (!$this->devel_mode && !preg_match('/\.min\.' . $ext . '$/', $file)) {
                $minified_file = substr($file, 0, strlen($ext) * -1) . 'min.' . $ext;
                if ($fs = @filemtime($minified_file)) {
                    $file = $minified_file . '?s=' . $fs;
                }
            }

            if (!$fs && ($fs = @filemtime($file))) {
                $file .= '?s=' . $fs;
            }
            $file = $this->file_mod($file);
        }

        return $matches[1] . '=' . $matches[2] . $file . $matches[4];
    }

    /**
     * Modify file by adding mtime indicator
     */
    protected function file_mod($file)
    {
        $fs  = false;
        $ext = substr($file, strrpos($file, '.') + 1);

        // use minified file if exists (not in development mode)
        if (!$this->devel_mode && !preg_match('/\.min\.' . $ext . '$/', $file)) {
            $minified_file = substr($file, 0, strlen($ext) * -1) . 'min.' . $ext;
            if ($fs = @filemtime($minified_file)) {
                return $minified_file . '?s=' . $fs;
            }
        }

        if ($fs = @filemtime($file)) {
            $file .= '?s=' . $fs;
        }

        return $file;
    }

    /**
@@ -1225,10 +1236,7 @@
    public function include_script($file, $position='head')
    {
        if (!preg_match('|^https?://|i', $file) && $file[0] != '/') {
            $file = $this->scripts_path . $file;
            if ($fs = @filemtime($file)) {
                $file .= '?s=' . $fs;
            }
            $file = $this->file_mod($this->scripts_path . $file);
        }

        if (!is_array($this->script_files[$position])) {