Payment_PayPal_SOAP
[ class tree: Payment_PayPal_SOAP ] [ index: Payment_PayPal_SOAP ] [ all elements ]

Source for file Error.php

Documentation is available at Error.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /**
  6.  * Payment_PayPal_SOAP is a package to easily use PayPal's SOAP API from PHP
  7.  *
  8.  * This file contains an error object
  9.  *
  10.  * PHP version 5
  11.  *
  12.  * LICENSE:
  13.  *
  14.  * Copyright (c) 2012 silverorange
  15.  *
  16.  * Permission is hereby granted, free of charge, to any person obtaining a copy
  17.  * of this software and associated documentation files (the "Software"), to deal
  18.  * in the Software without restriction, including without limitation the rights
  19.  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  20.  * copies of the Software, and to permit persons to whom the Software is
  21.  * furnished to do so, subject to the following conditions:
  22.  *
  23.  * The above copyright notice and this permission notice shall be included in
  24.  * all copies or substantial portions of the Software.
  25.  *
  26.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27.  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28.  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  29.  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  30.  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  31.  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  32.  * THE SOFTWARE.
  33.  *
  34.  * @category  Payment
  35.  * @package   Payment_PayPal_SOAP
  36.  * @author    Michael Gauthier <mike@silverorange.com>
  37.  * @copyright 2012 silverorange
  38.  * @license   http://www.opensource.org/licenses/mit-license.html MIT License
  39.  * @version   CVS: $Id$
  40.  * @link      http://pear.php.net/package/Payment_PayPal_SOAP
  41.  */
  42.  
  43. /**
  44.  * Error raised by the PayPal SOAP API
  45.  *
  46.  * Errors are aggregated by the {@link Payment_PayPal_SOAP_ErrorException}
  47.  * exception class.
  48.  *
  49.  * @category  Payment
  50.  * @package   Payment_PayPal_SOAP
  51.  * @author    Michael Gauthier <mike@silverorange.com>
  52.  * @copyright 2012 silverorange
  53.  * @license   http://www.opensource.org/licenses/mit-license.html MIT License
  54.  * @link      http://pear.php.net/package/Payment_PayPal_SOAP
  55.  * @see       Payment_PayPal_SOAP_ErrorException
  56.  */
  57. {
  58.     // {{{ class constants
  59.  
  60.     /**
  61.      * Default error type
  62.      */
  63.     const TYPE_DEFAULT = 0;
  64.  
  65.     /**
  66.      * Error type for expired PayPal Express Checkout tokens
  67.      */
  68.     const TYPE_EXPIRED_TOKEN = 1;
  69.  
  70.     // }}}
  71.     // {{{ protected properties
  72.  
  73.     /**
  74.      * Error message
  75.      *
  76.      * @var string 
  77.      *
  78.      * @see Payment_PayPal_SOAP_Error::getMessage()
  79.      * @see Payment_PayPal_SOAP_Error::setMessage()
  80.      */
  81.     protected $message = '';
  82.  
  83.     /**
  84.      * Error code as specified in the PayPal API error codes
  85.      *
  86.      * @var integer 
  87.      *
  88.      * @see Payment_PayPal_SOAP_Error::getCode()
  89.      * @see Payment_PayPal_SOAP_Error::setCode()
  90.      */
  91.     protected $code = 0;
  92.  
  93.     /**
  94.      * Error severity
  95.      *
  96.      * One of:
  97.      *
  98.      * - {@link Payment_PayPal_SOAP::ERROR_WARNING},
  99.      * - {@link Payment_PayPal_SOAP::ERROR_ERROR}, or
  100.      * - {@link Payment_PayPal_SOAP::ERROR_UNKNOWN}
  101.      *
  102.      * @var integer 
  103.      *
  104.      * @see Payment_PayPal_SOAP_Error::getSeverity()
  105.      * @see Payment_PayPal_SOAP_Error::setSeverity()
  106.      */
  107.     protected $severity = Payment_PayPal_SOAP::ERROR_UNKNOWN;
  108.  
  109.     /**
  110.      * Error type
  111.      *
  112.      * One of:
  113.      *
  114.      * - {@link Payment_PayPal_SOAP_Error::TYPE_DEFAULT}, or
  115.      * - {@link Payment_PayPal_SOAP_Error::TYPE_EXPIRED_TOKEN}
  116.      *
  117.      * @var integer 
  118.      *
  119.      * @see Payment_PayPal_SOAP_Error::getType()
  120.      * @see Payment_PayPal_SOAP_Error::setType()
  121.      */
  122.     protected $type = Payment_PayPal_SOAP_Error::TYPE_DEFAULT;
  123.  
  124.     // }}}
  125.     // {{{ __construct()
  126.  
  127.     /**
  128.      * Creates a new error object
  129.      *
  130.      * @param string  $message  the message of this error.
  131.      * @param integer $code     the code of this error.
  132.      * @param integer $severity the severity of this error.
  133.      * @param integer $type     the type of this error.
  134.      */
  135.     public function __construct($message$code$severity$type)
  136.     {
  137.         $this->setMessage($message);
  138.         $this->setCode($code);
  139.         $this->setSeverity($severity);
  140.         $this->setType($type);
  141.     }
  142.  
  143.     // }}}
  144.     // {{{ setMessage()
  145.  
  146.     /**
  147.      * Sets the message of this error
  148.      *
  149.      * @param string $message the message of this error.
  150.      *
  151.      * @return Payment_PayPal_SOAP_Error this object, for fluent interface.
  152.      */
  153.     public function setMessage($message)
  154.     {
  155.         $this->message = $message;
  156.         return $this;
  157.     }
  158.  
  159.     // }}}
  160.     // {{{ setCode()
  161.  
  162.     /**
  163.      * Sets the code of this error
  164.      *
  165.      * Should be a valid API error code as specified in the PayPal SOAP API.
  166.      *
  167.      * @param integer $code the code of this error.
  168.      *
  169.      * @return Payment_PayPal_SOAP_Error this object, for fluent interface.
  170.      */
  171.     public function setCode($code)
  172.     {
  173.         $this->code = (integer)$code;
  174.         return $this;
  175.     }
  176.  
  177.     // }}}
  178.     // {{{ setSeverity()
  179.  
  180.     /**
  181.      * Sets the severity of this error
  182.      *
  183.      * Valid severities are:
  184.      *
  185.      * - {@link Payment_PayPal_SOAP::ERROR_WARNING},
  186.      * - {@link Payment_PayPal_SOAP::ERROR_ERROR}, or
  187.      * - {@link Payment_PayPal_SOAP::ERROR_UNKNOWN}
  188.      *
  189.      * @param integer $severity the severity of this error.
  190.      *
  191.      * @return Payment_PayPal_SOAP_Error this object, for fluent interface.
  192.      */
  193.     public function setSeverity($severity)
  194.     {
  195.         $this->severity = (integer)$severity;
  196.         return $this;
  197.     }
  198.  
  199.     // }}}
  200.     // {{{ setType()
  201.  
  202.     /**
  203.      * Sets the type of this error
  204.      *
  205.      * Valid types are:
  206.      *
  207.      * - {@link Payment_PayPal_SOAP_Error::TYPE_DEFAULT}, or
  208.      * - {@link Payment_PayPal_SOAP_Error::TYPE_EXPIRED_TOKEN}
  209.      *
  210.      * @param integer $type the type of this error.
  211.      *
  212.      * @return Payment_PayPal_SOAP_Error this object, for fluent interface.
  213.      */
  214.     public function setType($type)
  215.     {
  216.         $this->type = (integer)$type;
  217.         return $this;
  218.     }
  219.  
  220.     // }}}
  221.     // {{{ getMessage()
  222.  
  223.     /**
  224.      * Gets the message of this error
  225.      *
  226.      * @return string the message of this error.
  227.      */
  228.     public function getMessage()
  229.     {
  230.         return $this->message;
  231.     }
  232.  
  233.     // }}}
  234.     // {{{ getCode()
  235.  
  236.     /**
  237.      * Gets the code of this error
  238.      *
  239.      * @return integer the code of this error.
  240.      */
  241.     public function getCode()
  242.     {
  243.         return $this->code;
  244.     }
  245.  
  246.     // }}}
  247.     // {{{ getSeverity()
  248.  
  249.     /**
  250.      * Gets the severity of this error
  251.      *
  252.      * @return integer the severity of this error.
  253.      */
  254.     public function getSeverity()
  255.     {
  256.         return $this->severity;
  257.     }
  258.  
  259.     // }}}
  260.     // {{{ getType()
  261.  
  262.     /**
  263.      * Gets the type of this error
  264.      *
  265.      * @return integer the type of this error.
  266.      */
  267.     public function getType()
  268.     {
  269.         return $this->type;
  270.     }
  271.  
  272.     // }}}
  273. }
  274.  
  275. ?>

Documentation generated on Tue, 25 Sep 2012 14:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.