summaryrefslogtreecommitdiff
path: root/buildscripts/phing/tasks/PradoDocTask.php
blob: 944fde82567ac62839e563b9fe9471073a46961a (plain)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<?php
require_once 'phing/Task.php';

/**
 * Task to run phpDocumentor for PRADO API docs.
 */	
class PradoDocTask extends Task
{
	private $phpdoc = 'phpdoc';
	
	private $title = "Default Title";
			
	private $destdir = ".";
			
	private $sourcepath = NULL;
	
	private $ignorelist = '';
	
	private $output = "";
			
	private $linksource = false;
	
	private $parseprivate = false;

	private $quite = false;

	function setPhpdoc($phpdoc)
	{
		$this->phpdoc=$phpdoc;
	}
	
	function setQuite($quite)
	{
		$this->quite=$quite;
	}

	/**
	 * Set the title for the generated documentation
	 */
	function setTitle($title)
	{
		$this->title = $title;
	}
	
	/**
	 * Set the destination directory for the generated documentation
	 */
	function setDestdir($destdir)
	{
		$this->destdir = $destdir;
	}
	
	/**
	 * Set the source path
	 */
	function setSourcepath(Path $sourcepath)
	{
		if ($this->sourcepath === NULL)
		{
			$this->sourcepath = $sourcepath;
		}
		else
		{
			$this->sourcepath->append($sourcepath);
		}
	}
	
	/**
	 * Set the output type
	 */		
	function setOutput($output)
	{
		$this->output = $output;
	}
	
	/**
	 * Should sources be linked in the generated documentation
	 */
	function setLinksource($linksource)
	{
		$this->linksource = $linksource;
	}

	function setIgnorelist($ignorelist)
	{
		$this->ignorelist=$ignorelist;
	}	
	
	/**
	 * Main entrypoint of the task
	 */
	function main()
	{
		$arguments = $this->constructArguments();
		passthru($this->phpdoc . " " . $arguments, $retval);
	}
	
	/**
	 * Constructs an argument string for phpDocumentor
	 */
	private function constructArguments()
	{
		$arguments = " ";

		if($this->quite)
		{
			$arguments .= '-q "on" ';
		}
		
		if ($this->title)
		{
			$arguments.= "-ti \"" . $this->title . "\" ";
		}
		
		if ($this->destdir)
		{
			$arguments.= "-t \"" . $this->destdir . "\" ";
		}
		
		if ($this->sourcepath !== NULL)
		{
			$arguments.= "-d \"" . $this->sourcepath->__toString() . "\" ";
		}
		
		if ($this->output)
		{
			$arguments.= "-o \"" . $this->output . "\" ";
		}
		
		if ($this->linksource)
		{
			$arguments.= "-s ";
		}
		
		if ($this->parseprivate)
		{
			$arguments.= "-pp ";
		}

		if ($this->ignorelist)
		{
			$arguments.='-i "'.$this->ignorelist.'" ';
		}

		return $arguments;
	}
}

?>