Blame view

sources/3rdparty/sabre/dav/lib/Sabre/HTTP/AbstractAuth.php 2.04 KB
03e52840d   Kload   Init
1
  <?php
6d9380f96   Cédric Dupont   Update sources OC...
2
  namespace Sabre\HTTP;
03e52840d   Kload   Init
3
4
5
6
7
  /**
   * HTTP Authentication baseclass
   *
   * This class has the common functionality for BasicAuth and DigestAuth
   *
6d9380f96   Cédric Dupont   Update sources OC...
8
9
10
   * @copyright Copyright (C) 2007-2014 fruux GmbH (https://fruux.com/).
   * @author Evert Pot (http://evertpot.com/)
   * @license http://sabre.io/license/ Modified BSD License
03e52840d   Kload   Init
11
   */
6d9380f96   Cédric Dupont   Update sources OC...
12
  abstract class AbstractAuth {
03e52840d   Kload   Init
13
14
15
16
17
18
19
20
21
22
23
24
25
  
      /**
       * The realm will be displayed in the dialog boxes
       *
       * This identifier can be changed through setRealm()
       *
       * @var string
       */
      protected $realm = 'SabreDAV';
  
      /**
       * HTTP response helper
       *
6d9380f96   Cédric Dupont   Update sources OC...
26
       * @var Sabre\HTTP\Response
03e52840d   Kload   Init
27
28
29
30
31
32
33
       */
      protected $httpResponse;
  
  
      /**
       * HTTP request helper
       *
6d9380f96   Cédric Dupont   Update sources OC...
34
       * @var Sabre\HTTP\Request
03e52840d   Kload   Init
35
36
37
38
39
40
41
42
       */
      protected $httpRequest;
  
      /**
       * __construct
       *
       */
      public function __construct() {
6d9380f96   Cédric Dupont   Update sources OC...
43
44
          $this->httpResponse = new Response();
          $this->httpRequest = new Request();
03e52840d   Kload   Init
45
46
47
48
49
50
  
      }
  
      /**
       * Sets an alternative HTTP response object
       *
6d9380f96   Cédric Dupont   Update sources OC...
51
       * @param Response $response
03e52840d   Kload   Init
52
53
       * @return void
       */
6d9380f96   Cédric Dupont   Update sources OC...
54
      public function setHTTPResponse(Response $response) {
03e52840d   Kload   Init
55
56
57
58
59
60
61
62
  
          $this->httpResponse = $response;
  
      }
  
      /**
       * Sets an alternative HTTP request object
       *
6d9380f96   Cédric Dupont   Update sources OC...
63
       * @param Request $request
03e52840d   Kload   Init
64
65
       * @return void
       */
6d9380f96   Cédric Dupont   Update sources OC...
66
      public function setHTTPRequest(Request $request) {
03e52840d   Kload   Init
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
  
          $this->httpRequest = $request;
  
      }
  
  
      /**
       * Sets the realm
       *
       * The realm is often displayed in authentication dialog boxes
       * Commonly an application name displayed here
       *
       * @param string $realm
       * @return void
       */
      public function setRealm($realm) {
  
          $this->realm = $realm;
  
      }
  
      /**
       * Returns the realm
       *
       * @return string
       */
      public function getRealm() {
  
          return $this->realm;
  
      }
  
      /**
       * Returns an HTTP 401 header, forcing login
       *
       * This should be called when username and password are incorrect, or not supplied at all
       *
       * @return void
       */
      abstract public function requireLogin();
  
  }