aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Rest/RequestBase.php
blob: cacef62d473dba92258d134ff3e56e9a871c66fc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
109
110
111
112
113
114
115
<?php

namespace MediaWiki\Rest;

/**
 * Shared code between RequestData and RequestFromGlobals
 */
abstract class RequestBase implements RequestInterface {
	/**
	 * @var HeaderContainer|null
	 */
	private $headerCollection;

	/** @var array */
	private $attributes = [];

	/** @var string */
	private $cookiePrefix;

	/**
	 * @internal
	 * @param string $cookiePrefix
	 */
	protected function __construct( $cookiePrefix ) {
		$this->cookiePrefix = $cookiePrefix;
	}

	/**
	 * Override this in the implementation class if lazy initialisation of
	 * header values is desired. It should call setHeaders().
	 *
	 * @internal
	 */
	protected function initHeaders() {
	}

	public function __clone() {
		if ( $this->headerCollection !== null ) {
			$this->headerCollection = clone $this->headerCollection;
		}
	}

	/**
	 * Erase any existing headers and replace them with the specified header
	 * lines.
	 *
	 * Call this either from the constructor or from initHeaders() of the
	 * implementing class.
	 *
	 * @internal
	 * @param string[] $headers The header lines
	 */
	protected function setHeaders( $headers ) {
		$this->headerCollection = new HeaderContainer;
		$this->headerCollection->resetHeaders( $headers );
	}

	public function getHeaders() {
		if ( $this->headerCollection === null ) {
			$this->initHeaders();
		}
		return $this->headerCollection->getHeaders();
	}

	public function getHeader( $name ) {
		if ( $this->headerCollection === null ) {
			$this->initHeaders();
		}
		return $this->headerCollection->getHeader( $name );
	}

	public function hasHeader( $name ) {
		if ( $this->headerCollection === null ) {
			$this->initHeaders();
		}
		return $this->headerCollection->hasHeader( $name );
	}

	public function getHeaderLine( $name ) {
		if ( $this->headerCollection === null ) {
			$this->initHeaders();
		}
		return $this->headerCollection->getHeaderLine( $name );
	}

	public function setAttributes( $attributes ) {
		$this->attributes = $attributes;
	}

	public function getAttributes() {
		return $this->attributes;
	}

	public function getAttribute( $name, $default = null ) {
		if ( array_key_exists( $name, $this->attributes ) ) {
			return $this->attributes[$name];
		} else {
			return $default;
		}
	}

	public function getCookiePrefix() {
		return $this->cookiePrefix;
	}

	public function getCookie( $name, $default = null ) {
		$cookies = $this->getCookieParams();
		$prefixedName = $this->getCookiePrefix() . $name;
		if ( array_key_exists( $prefixedName, $cookies ) ) {
			return $cookies[$prefixedName];
		} else {
			return $default;
		}
	}
}