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
|
<?php
/**
* Copyright (c) 2007-2011 bitExpert AG
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
require_once 'phing/tasks/ext/liquibase/AbstractLiquibaseTask.php';
/**
* Task to create a javadoc-like documentation based on current database and
* changelog.
*
* @author Stephan Hochdoerfer <S.Hochdoerfer@bitExpert.de>
* @version $Id: e79fae92fc7e2d2f490473a2449a909b2812c60f $
* @since 2.4.10
* @package phing.tasks.ext.liquibase
*/
class LiquibaseDbDocTask extends AbstractLiquibaseTask
{
protected $outputDir;
/**
* Sets the output directory where the documentation gets generated to.
*
* @param string the output directory
*/
public function setOutputDir($outputDir)
{
$this->outputDir = $outputDir;
}
/**
* @see AbstractTask::checkParams()
*/
protected function checkParams()
{
parent::checkParams();
if((null === $this->outputDir) or !is_dir($this->outputDir))
{
if(!mkdir($this->outputDir, 0777, true))
{
throw new BuildException(
sprintf(
'The directory "%s" does not exist and could not be created!',
$this->outputDir
)
);
}
}
if(!is_writable($this->outputDir))
{
throw new BuildException(
sprintf(
'The directory "%s" is not writable!',
$this->outputDir
)
);
}
}
/**
* @see Task::main()
*/
public function main()
{
$this->checkParams();
$this->execute('dbdoc', escapeshellarg($this->outputDir));
}
}
|
