Source for file jResponseCmdline.class.php

Documentation is available at jResponseCmdline.class.php

  1. <?php
  2. /**
  3. * @package     jelix
  4. * @subpackage  core_response
  5. * @author      Christophe Thiriot
  6. * @contributor Laurent Jouanneau
  7. * @copyright   2008 Christophe Thiriot, 2008-2010 Laurent Jouanneau
  8. * @link        http://www.jelix.org
  9. * @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  10. */
  11.  
  12. /**
  13. * Command line response
  14. * @package  jelix
  15. * @subpackage core_response
  16. */
  17. class jResponseCmdline extends jResponse {
  18.     /**
  19.      * Code used by exit function in the end of the process if no error occured
  20.      */
  21.     const EXIT_CODE_OK = 0;
  22.  
  23.     /**
  24.      * Code used by exit function in the end of the process if an error occured
  25.      */
  26.     const EXIT_CODE_ERROR = 1;
  27.  
  28.     /**
  29.     * @var string 
  30.     */
  31.     protected $_type = 'cmdline';
  32.  
  33.     /**
  34.      * @var string 
  35.      */
  36.     protected $_buffer = '';
  37.  
  38.     /**
  39.      * @var int 
  40.      */
  41.     protected $_exit_code = self::EXIT_CODE_OK;
  42.  
  43.     /**
  44.      * output the content with the text/plain mime type
  45.      * @return boolean 
  46.      */
  47.     public function output(){
  48.         $this->flushContent();
  49.         return true;
  50.     }
  51.  
  52.     /**
  53.      * Send the specified content to the standard output.
  54.      * The content can be bufferized and displayed only when you call flushContent
  55.      * or do a non-bufferized addContent
  56.      * 
  57.      * @param string $content 
  58.      * @param bool   $bufferize 
  59.      * @return void 
  60.      */
  61.     public function addContent($content, $bufferize=false){
  62.         if ($bufferize){
  63.             $this->_buffer.= $content;
  64.         } else {
  65.             $this->flushContent();
  66.             echo $content;
  67.         }
  68.     }
  69.  
  70.     /**
  71.      * Send the bufferized content to the standard output
  72.      * 
  73.      * @return void 
  74.      */
  75.     public function flushContent(){
  76.         echo $this->_buffer;
  77.         $this->_buffer = '';
  78.     }
  79.  
  80.     /**
  81.      * Get the exit code of the command line response
  82.      * 
  83.      * @return int 
  84.      */
  85.     public function getExitCode(){
  86.         return $this->_exit_code;
  87.     }
  88.  
  89.     /**
  90.      * Set the exit code of the command line
  91.      * 
  92.      * @param mixed $code The code that will be passed to the exit() function
  93.      * @return void 
  94.      */
  95.     public function setExitCode($code){
  96.         $this->_exit_code = $code;
  97.     }
  98.  
  99.     /**
  100.      * output errors
  101.      */
  102.     public function outputErrors(){
  103.         $this->flushContent();
  104.         foreach(jApp::coord()->allErrorMessages as $msg)
  105.             fwrite(STDERR, $msg->getFormatedMessage()."\n");
  106.         $this->setExitCode(self::EXIT_CODE_ERROR);
  107.     }
  108.  
  109.     /**
  110.      * No Http Header here
  111.      */
  112.     protected function sendHttpHeaders(){}
  113. }

Documentation generated on Wed, 04 Jan 2017 22:56:12 +0100 by phpDocumentor 1.4.3