• Main Page
  • Related Pages
  • Modules
  • Classes
  • Files
  • Examples
  • File List
  • File Members

CAS/Request/RequestInterface.php

Go to the documentation of this file.
00001 <?php
00002 /*
00003  * Copyright © 2003-2010, The ESUP-Portail consortium & the JA-SIG Collaborative.
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions are met:
00008  *
00009  *         * Redistributions of source code must retain the above copyright notice,
00010  *               this list of conditions and the following disclaimer.
00011  *         * Redistributions in binary form must reproduce the above copyright notice,
00012  *               this list of conditions and the following disclaimer in the documentation
00013  *               and/or other materials provided with the distribution.
00014  *         * Neither the name of the ESUP-Portail consortium & the JA-SIG
00015  *               Collaborative nor the names of its contributors may be used to endorse or
00016  *               promote products derived from this software without specific prior
00017  *               written permission.
00018 
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00020  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
00023  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00026  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  */
00030 
00034 interface CAS_RequestInterface {
00035 
00036         /*********************************************************
00037          * Configure the Request
00038          *********************************************************/
00039 
00047         public function setUrl ($url);
00048 
00057         public function addCookie ($name, $value);
00058 
00068         public function addCookies (array $cookies);
00069 
00077         public function addHeader ($header);
00078 
00086         public function addHeaders (array $headers);
00087 
00094         public function makePost ();
00095 
00103         public function setPostBody ($body);
00104 
00105 
00113         public function setSslCaCert ($caCertPath);
00114 
00115 
00116 
00117         /*********************************************************
00118          * 2. Send the Request
00119          *********************************************************/
00120 
00127         public function send ();
00128 
00129         /*********************************************************
00130          * 3. Access the response
00131          *********************************************************/
00132 
00139         public function getResponseHeaders ();
00140 
00147         public function getResponseBody ();
00148 
00155         public function getErrorMessage ();
00156 }
00157 
00164 class CAS_OutOfSequenceException
00165         extends BadMethodCallException
00166 {
00167 
00168 }

Generated on Sat Mar 26 2011 12:11:03 for phpCAS by  doxygen 1.7.1