xref: /plugin/authssocas/vendor/apereo/phpcas/source/CAS/ProxyTicketException.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 * @class    CAS/ProxyTicketException.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/**
32*d10b5556SXylle * An Exception for errors related to fetching or validating proxy tickets.
33*d10b5556SXylle *
34*d10b5556SXylle * @class    CAS_ProxyTicketException
35*d10b5556SXylle * @category Authentication
36*d10b5556SXylle * @package  PhpCAS
37*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
38*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
39*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
40*d10b5556SXylle */
41*d10b5556SXylleclass CAS_ProxyTicketException
42*d10b5556SXylleextends BadMethodCallException
43*d10b5556SXylleimplements CAS_Exception
44*d10b5556SXylle{
45*d10b5556SXylle
46*d10b5556SXylle    /**
47*d10b5556SXylle     * Constructor
48*d10b5556SXylle     *
49*d10b5556SXylle     * @param string $message Message text
50*d10b5556SXylle     * @param int    $code    Error code
51*d10b5556SXylle     *
52*d10b5556SXylle     * @return void
53*d10b5556SXylle     */
54*d10b5556SXylle    public function __construct ($message, $code = PHPCAS_SERVICE_PT_FAILURE)
55*d10b5556SXylle    {
56*d10b5556SXylle        // Warn if the code is not in our allowed list
57*d10b5556SXylle        $ptCodes = array(
58*d10b5556SXylle        PHPCAS_SERVICE_PT_FAILURE,
59*d10b5556SXylle        PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE,
60*d10b5556SXylle        PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,
61*d10b5556SXylle        );
62*d10b5556SXylle        if (!in_array($code, $ptCodes)) {
63*d10b5556SXylle            trigger_error(
64*d10b5556SXylle                'Invalid code '.$code
65*d10b5556SXylle                .' passed. Must be one of PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, or PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE.'
66*d10b5556SXylle            );
67*d10b5556SXylle        }
68*d10b5556SXylle
69*d10b5556SXylle        parent::__construct($message, $code);
70*d10b5556SXylle    }
71*d10b5556SXylle}
72