- Update phpdoc (#1486958)

alecpl

2010-09-29 5c461bada970c336616b0c03c9036f89cab21d0c

 program/include/rcube_json_output.php

@@ -4,8 +4,8 @@
 +-----------------------------------------------------------------------+
 | program/include/rcube_json_output.php                                 |
 |                                                                       |
 | This file is part of the RoundCube Webmail client                     |
 | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland                 |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland                 |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
@@ -28,6 +28,11 @@
 */
class rcube_json_output
{
    /**
     * Stores configuration object.
     *
     * @var rcube_config
     */
    private $config;
    private $charset = RCMAIL_CHARSET;
    private $env = array();
@@ -36,24 +41,26 @@
    private $callbacks = array();
    private $message = null;

    public $browser;
    public $type = 'js';
    public $ajax_call = true;
    
    


    /**
     * Constructor
     */
    public function __construct($task)
    public function __construct($task=null)
    {
        $this->config = rcmail::get_instance()->config;
        $this->config  = rcmail::get_instance()->config;
        $this->browser = new rcube_browser();
    }


    /**
     * Set environment variable
     *
     * @param string Property name
     * @param mixed Property value
     * @param string $name Property name
     * @param mixed $value Property value
     */
    public function set_env($name, $value)
    {
@@ -64,7 +71,7 @@
    /**
     * Issue command to set page title
     *
     * @param string New page title
     * @param string $title New page title
     */
    public function set_pagetitle($title)
    {
@@ -96,8 +103,8 @@
    /**
     * Register a template object handler
     *
     * @param  string Object name
     * @param  string Function name to call
     * @param  string $obj Object name
     * @param  string $func Function name to call
     * @return void
     */
    public function add_handler($obj, $func)
@@ -109,7 +116,7 @@
    /**
     * Register a list of template object handlers
     *
     * @param  array Hash array with object=>handler pairs
     * @param  array $arr Hash array with object=>handler pairs
     * @return void
     */
    public function add_handlers($arr)
@@ -153,10 +160,10 @@
    /**
     * Invoke display_message command
     *
     * @param string Message to display
     * @param string Message type [notice|confirm|error]
     * @param array Key-value pairs to be replaced in localized text
     * @param boolean Override last set message
     * @param string  $message  Message to display
     * @param string  $type     Message type [notice|confirm|error]
     * @param array   $vars     Key-value pairs to be replaced in localized text
     * @param boolean $override Override last set message
     * @uses self::command()
     */
    public function show_message($message, $type='notice', $vars=null, $override=true)
@@ -186,7 +193,8 @@
    /**
     * Redirect to a certain url
     *
     * @param mixed Either a string with the action or url parameters as key-value pairs
     * @param mixed $p Either a string with the action or url parameters as key-value pairs
     * @param int $delay Delay in seconds
     * @see rcmail::url()
     */
    public function redirect($p = array(), $delay = 1)
@@ -210,7 +218,7 @@
    /**
     * Send an AJAX response with executable JS code
     *
     * @param  string  Additional JS code
     * @param  string  $add Additional JS code
     * @param  boolean True if output buffer should be flushed
     * @return void
     * @deprecated