Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/auth/cas/CAS/vendor/apereo/phpcas/source/CAS/Request/ -> RequestInterface.php (source)

[Source view]

Licensed to Jasig under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Jasig licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

Author: Adam Franco <afranco@middlebury.edu>
License: http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
File Size: 179 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CAS_Request_RequestInterface:: (13 methods):
  setUrl()
  addCookie()
  addCookies()
  addHeader()
  addHeaders()
  makePost()
  setPostBody()
  setSslCaCert()
  send()
  getResponseHeaders()
  getResponseStatusCode()
  getResponseBody()
  getErrorMessage()


Interface: CAS_Request_RequestInterface  - X-Ref

This interface defines a class library for performing web requests.

setUrl($url)   X-Ref
Set the URL of the Request

param: string $url url to set
return: void

addCookie($name, $value)   X-Ref
Add a cookie to the request.

param: string $name  name of cookie
param: string $value value of cookie
return: void

addCookies(array $cookies)   X-Ref
Add an array of cookies to the request.
The cookie array is of the form
array('cookie_name' => 'cookie_value', 'cookie_name2' => cookie_value2')

param: array $cookies cookies to add
return: void

addHeader($header)   X-Ref
Add a header string to the request.

param: string $header header to add
return: void

addHeaders(array $headers)   X-Ref
Add an array of header strings to the request.

param: array $headers headers to add
return: void

makePost()   X-Ref
Make the request a POST request rather than the default GET request.

return: void

setPostBody($body)   X-Ref
Add a POST body to the request

param: string $body body to add
return: void

setSslCaCert($caCertPath, $validate_cn = true)   X-Ref
Specify the path to an SSL CA certificate to validate the server with.

param: string  $caCertPath  path to cert file
param: boolean $validate_cn validate CN of SSL certificate
return: void

send()   X-Ref
Perform the request.

return: bool TRUE on success, FALSE on failure.

getResponseHeaders()   X-Ref
Answer the headers of the response.

return: array An array of header strings.

getResponseStatusCode()   X-Ref
Answer HTTP status code of the response

return: int

getResponseBody()   X-Ref
Answer the body of response.

return: string

getErrorMessage()   X-Ref
Answer a message describing any errors if the request failed.

return: string