summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/tasks/ext/svn/SvnInfoTask.php
blob: 68111d748157c2e2873fd0d8b304704128d6c71d (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
<?php
/**
 * $Id: 36ffb2ececed4c83c9ca7ad3674b3fa11074f2a5 $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

require_once 'phing/Task.php';
require_once 'phing/tasks/ext/svn/SvnBaseTask.php';

/**
 * Parses the output of 'svn info --xml' and
 *
 * @author Michiel Rook <mrook@php.net>
 * @version $Id: 36ffb2ececed4c83c9ca7ad3674b3fa11074f2a5 $
 * @package phing.tasks.ext.svn
 * @see VersionControl_SVN
 * @since 2.4.9
 */
class SvnInfoTask extends SvnBaseTask
{
    private $propertyName = "svn.info";
    
    private $element = 'url';
    private $subElement = null;

    /**
     * Sets the name of the property to use
     */
    public function setPropertyName($propertyName)
    {
        $this->propertyName = $propertyName;
    }

    /**
     * Returns the name of the property to use
     */
    public function getPropertyName()
    {
        return $this->propertyName;
    }
    
    /**
     * Sets the name of the xml element to use
     */
    public function setElement($element)
    {
        $this->element = $element;
    }
    
    /**
     * Returns the name of the xml element to use
     */
    public function getElement()
    {
        return $this->element;
    }

    /**
     * Sets the name of the xml sub element to use
     */
    public function setSubElement($subElement)
    {
        $this->subElement = $subElement;
    }
    
    /**
     * Returns the name of the xml sub element to use
     */
    public function getSubElement()
    {
        return $this->subElement;
    }

    /**
     * The main entry point
     *
     * @throws BuildException
     */
    function main()
    {
        $this->setup('info');

        $output = $this->run(array('--xml', '--incremental'));
            
        if ($xmlObj = @simplexml_load_string($output)) {
            $object = $xmlObj->{$this->element};
            
            if (!empty($this->subElement)) {
                $object = $object->{$this->subElement};
            }
                
            $this->project->setProperty($this->getPropertyName(), (string) $object);
        } else {
            throw new BuildException("Failed to parse the output of 'svn info --xml'.");
        }
    }
}