- 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-2009, 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:                                                              |
@@ -16,7 +16,7 @@
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id:  $
 $Id$

*/

@@ -28,46 +28,57 @@
 */
class rcube_json_output
{
    /**
     * Stores configuration object.
     *
     * @var rcube_config
     */
    private $config;
    private $charset = 'UTF-8';
    private $charset = RCMAIL_CHARSET;
    private $env = array();
    private $texts = array();
    private $commands = array();
    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)
    {
        $this->env[$name] = $value;
    }
    


    /**
     * Issue command to set page title
     *
     * @param string New page title
     * @param string $title New page title
     */
    public function set_pagetitle($title)
    {
        $name = $this->config->get('product_name');
        $this->command('set_pagetitle', JQ(empty($name) ? $title : $name.' :: '.$title));
        $this->command('set_pagetitle', empty($name) ? $title : $name.' :: '.$title);
    }


    /**
     * @ignore
@@ -92,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)
@@ -101,18 +112,19 @@
        // ignore
    }


    /**
     * 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)
    {
        // ignore
    }
    
    


    /**
     * Call a client method
     *
@@ -121,7 +133,12 @@
     */
    public function command()
    {
        $this->commands[] = func_get_args();
        $cmd = func_get_args();
        
        if (strpos($cmd[0], 'plugin.') === 0)
          $this->callbacks[] = $cmd;
        else
          $this->commands[] = $cmd;
    }
    
    
@@ -138,25 +155,30 @@
            $this->texts[$name] = rcube_label($name);
        }
    }
    


    /**
     * 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 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)
    public function show_message($message, $type='notice', $vars=null, $override=true)
    {
        $this->command(
            'display_message',
            rcube_label(array('name' => $message, 'vars' => $vars)),
            $type
        );
        if ($override || !$this->message) {
            $this->message = $message;
            $this->command(
                'display_message',
                rcube_label(array('name' => $message, 'vars' => $vars)),
                $type
            );
        }
    }
    


    /**
     * Delete all stored env variables and commands
     */
@@ -166,11 +188,13 @@
        $this->texts = array();
        $this->commands = array();
    }
    


    /**
     * 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)
@@ -194,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
@@ -207,7 +231,6 @@
            $s_header_sent = true;
            send_nocacheing_headers();
            header('Content-Type: text/plain; charset=' . $this->get_charset());
            print '/** ajax response ['.date('d/M/Y h:i:s O')."] **/\n";
        }

        // unset default env vars
@@ -217,18 +240,21 @@
        $response = array('action' => $rcmail->action, 'unlock' => (bool)$_REQUEST['_unlock']);
        
        if (!empty($this->env))
          $response['env'] = $this->env;
            $response['env'] = $this->env;
          
        if (!empty($this->texts))
          $response['texts'] = $this->texts;
            $response['texts'] = $this->texts;

        // send response code
        // send function calls
        $response['exec'] = $this->get_js_commands() . $add;
        
        if (!empty($this->callbacks))
            $response['callbacks'] = $this->callbacks;

        echo json_serialize($response);
    }
    
    


    /**
     * Return executable javascript code for all registered commands
     *
@@ -237,7 +263,7 @@
    private function get_js_commands()
    {
        $out = '';
        

        foreach ($this->commands as $i => $args) {
            $method = array_shift($args);
            foreach ($args as $i => $arg) {
@@ -254,5 +280,3 @@
        return $out;
    }
}