Exception.php 1.9 KB

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