CAS/CAS/Exception.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  * @file     CAS/Exception.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  * A root exception interface for all exceptions in phpCAS.
  32  *
  33  * All exceptions thrown in phpCAS should implement this interface to allow them
  34  * to be caught as a category by clients. Each phpCAS exception should extend
  35  * an appropriate SPL exception class that best fits its type.
  36  *
  37  * For example, an InvalidArgumentException in phpCAS should be defined as
  38  *
  39  *              class CAS_InvalidArgumentException
  40  *                      extends InvalidArgumentException
  41  *                      implements CAS_Exception
  42  *              { }
  43  *
  44  * This definition allows the CAS_InvalidArgumentException to be caught as either
  45  * an InvalidArgumentException or as a CAS_Exception.
  46  *
  47  * @class    CAS_Exception
  48  * @category Authentication
  49  * @package  PhpCAS
  50  * @author   Adam Franco <afranco@middlebury.edu>
  51  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  52  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  53  *
  54  */
  55 interface CAS_Exception
  56 {
  57
  58 }
  59 ?>