forked from phpDocumentor/phpDocumentor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConfiguration.php
More file actions
126 lines (113 loc) · 3.04 KB
/
Copy pathConfiguration.php
File metadata and controls
126 lines (113 loc) · 3.04 KB
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
116
117
118
119
120
121
122
123
124
125
126
<?php
/**
* phpDocumentor
*
* PHP Version 5.4
*
* @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor;
use JMS\Serializer\Annotation as Serializer;
use phpDocumentor\Configuration\Merger\Annotation as Merger;
use phpDocumentor\Plugin\Plugin;
/**
* The definition for the configuration of phpDocumentor.
*/
class Configuration
{
/**
* @var string The title for the generated documentation.
* @Serializer\Type("string")
*/
protected $title = '';
/**
* @var Parser\Configuration The settings used during the parsing phase.
* @Serializer\Type("phpDocumentor\Parser\Configuration")
*/
protected $parser;
/**
* @var Parser\Configuration\Files contains a list of all files and directories to parse and to ignore.
* @Serializer\Type("phpDocumentor\Parser\Configuration\Files")
* @deprecated to be removed in phpDocumentor 4
*/
protected $files;
/**
* @var Plugin[] $plugins contains a listing of all plugins that should be loaded during startup.
* @Serializer\Type("array<phpDocumentor\Plugin\Plugin>")
* @Serializer\XmlList(entry = "plugin")
* @Merger\Replace
*/
protected $plugins = array();
/**
* Initializes all settings with their default values.
*/
public function __construct()
{
$this->files = new Parser\Configuration\Files();
$this->parser = new Parser\Configuration();
}
/**
* Returns the title for the generated documentation.
*
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* Registers the title for the generated documentation.
*
* @param string $title
*
* @return void
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* Returns the configuration related to which files are to be parsed.
*
* @deprecated to be removed in phpDocumentor 4
* @see Parser\Configuration::setFiles() for the new location.
*
* @return Parser\Configuration\Files
*/
public function getFiles()
{
return $this->files ?: $this->getParser()->getFiles();
}
/**
* Registers the configuration related to which files are to be parsed.
*
* @deprecated to be removed in phpDocumentor 4
* @see Parser\Configuration::setFiles() for the new location.
*
* @return Parser\Configuration\Files
*/
public function setFiles($files)
{
$this->files = $files;
}
/**
* Returns the configuration used by the parser.
*
* @return Parser\Configuration
*/
public function getParser()
{
return $this->parser;
}
/**
* Returns a list of all plugins that should be loaded by the application.
*
* @return Plugin[]
*/
public function getPlugins()
{
return $this->plugins;
}
}