xref: /plugin/authssocas/vendor/apereo/phpcas/source/CAS/ProxiedService/Testable.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/ProxiedService/Testabel.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 * This interface defines methods that allow proxy-authenticated service handlers
32*d10b5556SXylle * to be tested in unit tests.
33*d10b5556SXylle *
34*d10b5556SXylle * Classes implementing this interface SHOULD store the CAS_Client passed and
35*d10b5556SXylle * initialize themselves with that client rather than via the static phpCAS
36*d10b5556SXylle * method. For example:
37*d10b5556SXylle *
38*d10b5556SXylle *		/ **
39*d10b5556SXylle *		 * Fetch our proxy ticket.
40*d10b5556SXylle *		 * /
41*d10b5556SXylle *		protected function initializeProxyTicket() {
42*d10b5556SXylle *			// Allow usage of a particular CAS_Client for unit testing.
43*d10b5556SXylle *			if (is_null($this->casClient))
44*d10b5556SXylle *				phpCAS::initializeProxiedService($this);
45*d10b5556SXylle *			else
46*d10b5556SXylle *				$this->casClient->initializeProxiedService($this);
47*d10b5556SXylle *		}
48*d10b5556SXylle *
49*d10b5556SXylle * @class    CAS_ProxiedService_Testabel
50*d10b5556SXylle * @category Authentication
51*d10b5556SXylle * @package  PhpCAS
52*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
53*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
54*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
55*d10b5556SXylle */
56*d10b5556SXylleinterface CAS_ProxiedService_Testable
57*d10b5556SXylle{
58*d10b5556SXylle
59*d10b5556SXylle    /**
60*d10b5556SXylle     * Use a particular CAS_Client->initializeProxiedService() rather than the
61*d10b5556SXylle     * static phpCAS::initializeProxiedService().
62*d10b5556SXylle     *
63*d10b5556SXylle     * This method should not be called in standard operation, but is needed for unit
64*d10b5556SXylle     * testing.
65*d10b5556SXylle     *
66*d10b5556SXylle     * @param CAS_Client $casClient Cas client object
67*d10b5556SXylle     *
68*d10b5556SXylle     * @return void
69*d10b5556SXylle     * @throws CAS_OutOfSequenceException If called after a proxy ticket has
70*d10b5556SXylle     *         already been initialized/set.
71*d10b5556SXylle     */
72*d10b5556SXylle    public function setCasClient (CAS_Client $casClient);
73*d10b5556SXylle
74*d10b5556SXylle}
75*d10b5556SXylle?>
76