xref: /plugin/authssocas/vendor/apereo/phpcas/source/CAS/Exception.php (revision d10b5556242e78d8a430c323b91984ec16415a46)
1*d10b5556SXylle<?php
2*d10b5556SXylle
3*d10b5556SXylle/**
4*d10b5556SXylle * Licensed to Jasig under one or more contributor license
5*d10b5556SXylle * agreements. See the NOTICE file distributed with this work for
6*d10b5556SXylle * additional information regarding copyright ownership.
7*d10b5556SXylle *
8*d10b5556SXylle * Jasig licenses this file to you under the Apache License,
9*d10b5556SXylle * Version 2.0 (the "License"); you may not use this file except in
10*d10b5556SXylle * compliance with the License. You may obtain a copy of the License at:
11*d10b5556SXylle *
12*d10b5556SXylle * http://www.apache.org/licenses/LICENSE-2.0
13*d10b5556SXylle *
14*d10b5556SXylle * Unless required by applicable law or agreed to in writing, software
15*d10b5556SXylle * distributed under the License is distributed on an "AS IS" BASIS,
16*d10b5556SXylle * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17*d10b5556SXylle * See the License for the specific language governing permissions and
18*d10b5556SXylle * limitations under the License.
19*d10b5556SXylle *
20*d10b5556SXylle * PHP Version 7
21*d10b5556SXylle *
22*d10b5556SXylle * @file     CAS/Exception.php
23*d10b5556SXylle * @category Authentication
24*d10b5556SXylle * @package  PhpCAS
25*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
26*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
27*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
28*d10b5556SXylle */
29*d10b5556SXylle
30*d10b5556SXylle/**
31*d10b5556SXylle * A root exception interface for all exceptions in phpCAS.
32*d10b5556SXylle *
33*d10b5556SXylle * All exceptions thrown in phpCAS should implement this interface to allow them
34*d10b5556SXylle * to be caught as a category by clients. Each phpCAS exception should extend
35*d10b5556SXylle * an appropriate SPL exception class that best fits its type.
36*d10b5556SXylle *
37*d10b5556SXylle * For example, an InvalidArgumentException in phpCAS should be defined as
38*d10b5556SXylle *
39*d10b5556SXylle *		class CAS_InvalidArgumentException
40*d10b5556SXylle *			extends InvalidArgumentException
41*d10b5556SXylle *			implements CAS_Exception
42*d10b5556SXylle *		{ }
43*d10b5556SXylle *
44*d10b5556SXylle * This definition allows the CAS_InvalidArgumentException to be caught as either
45*d10b5556SXylle * an InvalidArgumentException or as a CAS_Exception.
46*d10b5556SXylle *
47*d10b5556SXylle * @class    CAS_Exception
48*d10b5556SXylle * @category Authentication
49*d10b5556SXylle * @package  PhpCAS
50*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
51*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
52*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
53*d10b5556SXylle *
54*d10b5556SXylle */
55*d10b5556SXylleinterface CAS_Exception
56*d10b5556SXylle{
57*d10b5556SXylle
58*d10b5556SXylle}
59*d10b5556SXylle?>
60