library/Zend/Console/Getopt/Exception.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Console_Getopt
  17  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  18  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19  * @version    $Id: Exception.php 16971 2009-07-22 18:05:45Z mikaelkael $
  20  */
  21
  22
  23 /**
  24  * @see Zend_Console_Getopt_Exception
  25  */
  26 require_once 'Zend/Exception.php';
  27
  28
  29 /**
  30  * @category   Zend
  31  * @package    Zend_Console_Getopt
  32  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  33  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  34  */
  35 class Zend_Console_Getopt_Exception extends Zend_Exception
  36 {
  37     /**
  38      * Usage
  39      *
  40      * @var string
  41      */
  42     protected $usage = '';
  43
  44     /**
  45      * Constructor
  46      *
  47      * @param string $message
  48      * @param string $usage
  49      * @return void
  50      */
  51     public function __construct($message, $usage = '')
  52     {
  53         $this->usage = $usage;
  54         parent::__construct($message);
  55     }
  56
  57     /**
  58      * Returns the usage
  59      *
  60      * @return string
  61      */
  62     public function getUsageMessage()
  63     {
  64         return $this->usage;
  65     }
  66 }