[Summary view]

   1  <?php
   2  
   3  /**
   4   * Licensed to Jasig under one or more contributor license
   5   * agreements. See the NOTICE file distributed with this work for
   6   * additional information regarding copyright ownership.
   7   *
   8   * Jasig licenses this file to you under the Apache License,
   9   * Version 2.0 (the "License"); you may not use this file except in
  10   * compliance with the License. You may obtain a copy of the License at:
  11   *
  12   * http://www.apache.org/licenses/LICENSE-2.0
  13   *
  14   * Unless required by applicable law or agreed to in writing, software
  15   * distributed under the License is distributed on an "AS IS" BASIS,
  16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17   * See the License for the specific language governing permissions and
  18   * limitations under the License.
  19   *
  20   * PHP Version 7
  21   *
  22   * @file     CAS/ServerHostname/Interface.php
  23   * @category Authentication
  24   * @package  PhpCAS
  25   * @author   Henry Pan <git@phy25.com>
  26   * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  27   * @link     https://wiki.jasig.org/display/CASC/phpCAS
  28   */
  29  
  30  /**
  31   * An interface for classes that gets the server name of the PHP server.
  32   * This is used to generate service URL and PGT callback URL.
  33   *
  34   * @class    CAS_ServiceBaseUrl_Interface
  35   * @category Authentication
  36   * @package  PhpCAS
  37   * @author   Henry Pan <git@phy25.com>
  38   * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  39   * @link     https://wiki.jasig.org/display/CASC/phpCAS
  40   */
  41  interface CAS_ServiceBaseUrl_Interface
  42  {
  43  
  44      /**
  45       * Get PHP HTTP protocol and server name.
  46       *
  47       * @return string protocol, server hostname, and optionally port,
  48       *                without trailing slash (https://localhost:8443)
  49       */
  50      public function get();
  51  
  52      /**
  53       * Check whether HTTPS is used.
  54       *
  55       * This is used to construct the protocol in the URL.
  56       *
  57       * @return bool true if HTTPS is used
  58       */
  59      public function isHttps();
  60  
  61  }