CAS/CAS/ProxyTicketException.php

   1 <?php
   2
   3 /**
   4  * Licensed to Jasig under one or more contributor license
   5  * agreements. See the NOTICE file distributed with this work for
   6  * additional information regarding copyright ownership.
   7  *
   8  * Jasig licenses this file to you under the Apache License,
   9  * Version 2.0 (the "License"); you may not use this file except in
  10  * compliance with the License. You may obtain a copy of the License at:
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * PHP Version 5
  21  *
  22  * @class    CAS/ProxyTicketException.php
  23  * @category Authentication
  24  * @package  PhpCAS
  25  * @author   Adam Franco <afranco@middlebury.edu>
  26  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  27  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  28  *
  29  */
  30
  31 /**
  32  * An Exception for errors related to fetching or validating proxy tickets.
  33  *
  34  * @class    CAS_ProxyTicketException
  35  * @category Authentication
  36  * @package  PhpCAS
  37  * @author   Adam Franco <afranco@middlebury.edu>
  38  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  39  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  40  */
  41 class CAS_ProxyTicketException
  42 extends BadMethodCallException
  43 implements CAS_Exception
  44 {
  45
  46     /**
  47      * Constructor
  48      *
  49      * @param string $message Message text
  50      * @param int    $code    Error code
  51      *
  52      * @return void
  53      */
  54     public function __construct ($message, $code = PHPCAS_SERVICE_PT_FAILURE)
  55     {
  56         // Warn if the code is not in our allowed list
  57         $ptCodes = array(
  58         PHPCAS_SERVICE_PT_FAILURE,
  59         PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE,
  60         PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,
  61         );
  62         if (!in_array($code, $ptCodes)) {
  63             trigger_error('Invalid code '.$code.' passed. Must be one of PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, or PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE.');
  64         }
  65
  66         parent::__construct($message, $code);
  67     }
  68 }