1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* src/Directives/Disclosure.php |
4
|
|
|
* |
5
|
|
|
* @package php-security-txt |
6
|
|
|
* @author Austin Heap <[email protected]> |
7
|
|
|
* @version v0.4.0 |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
declare(strict_types = 1); |
11
|
|
|
|
12
|
|
|
namespace AustinHeap\Security\Txt\Directives; |
13
|
|
|
|
14
|
|
|
use AustinHeap\Security\Txt\SecurityTxt; |
15
|
|
|
use Exception; |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* Disclosure |
19
|
|
|
* |
20
|
|
|
* @link https://github.com/austinheap/php-security-txt |
21
|
|
|
* @link https://packagist.org/packages/austinheap/php-security-txt |
22
|
|
|
* @link https://austinheap.github.io/php-security-txt/classes/AustinHeap.Security.Txt.SecurityTxt.html |
23
|
|
|
* @link https://securitytext.org/ |
24
|
|
|
*/ |
25
|
|
|
trait Disclosure |
26
|
|
|
{ |
27
|
|
|
|
28
|
|
|
/** |
29
|
|
|
* The disclosure policy. |
30
|
|
|
* |
31
|
|
|
* @var string |
32
|
|
|
*/ |
33
|
|
|
protected $disclosure = null; |
34
|
|
|
|
35
|
|
|
/** |
36
|
|
|
* Set the disclosure policy. |
37
|
|
|
* |
38
|
|
|
* @param string $disclosure |
39
|
|
|
* |
40
|
|
|
* @return \AustinHeap\Security\Txt\SecurityTxt |
41
|
|
|
*/ |
42
|
3 |
|
public function setDisclosure(string $disclosure): SecurityTxt |
43
|
|
|
{ |
44
|
3 |
|
if (!$this->validDisclosure($disclosure)) { |
45
|
1 |
|
throw new Exception('Disclosure policy must be either "full", "partial", or "none".'); |
46
|
|
|
} |
47
|
|
|
|
48
|
2 |
|
$this->disclosure = $disclosure; |
49
|
|
|
|
50
|
2 |
|
return $this; |
|
|
|
|
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* Get the disclosure policy. |
55
|
|
|
* |
56
|
|
|
* @return string |
57
|
|
|
*/ |
58
|
1 |
|
public function getDisclosure(): string |
59
|
|
|
{ |
60
|
1 |
|
return $this->disclosure; |
61
|
|
|
} |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* Determines if disclosure is valid. |
65
|
|
|
* |
66
|
|
|
* @param string $disclosure |
67
|
|
|
* |
68
|
|
|
* @return bool |
69
|
|
|
*/ |
70
|
3 |
|
public function validDisclosure(string $disclosure): bool |
71
|
|
|
{ |
72
|
3 |
|
return in_array($disclosure, ['full', 'partial', 'none'], true); |
73
|
|
|
} |
74
|
|
|
} |
75
|
|
|
|