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
|
<?php
/*
* $Id: e1f8e20eb87ea465d29ba3add6fada790642bcf8 $
*
* 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/types/selectors/FileSelector.php';
/**
* A convenience base class that you can subclass Selectors from. It
* provides some helpful common behaviour. Note that there is no need
* for Selectors to inherit from this class, it is only necessary that
* they implement FileSelector.
*
* @author <a href="mailto:bruce@callenish.com">Bruce Atherton</a>
* @package phing.types.selectors
*/
abstract class BaseSelector extends DataType implements FileSelector {
private $errmsg = null;
/**
* Allows all selectors to indicate a setup error. Note that only
* the first error message is recorded.
*
* @param msg The error message any BuildException should throw.
*/
public function setError($msg) {
if ($this->errmsg === null) {
$this->errmsg = $msg;
}
}
/**
* Returns any error messages that have been set.
*
* @return the error condition
*/
public function getError() {
return $this->errmsg;
}
/**
* <p>Subclasses can override this method to provide checking of their
* state. So long as they call validate() from isSelected(), this will
* be called automatically (unless they override validate()).</p>
* <p>Implementations should check for incorrect settings and call
* setError() as necessary.</p>
*/
public function verifySettings() {
}
/**
* Subclasses can use this to throw the requisite exception
* in isSelected() in the case of an error condition.
*/
public function validate() {
if ($this->getError() === null) {
$this->verifySettings();
}
if ($this->getError() !== null) {
throw new BuildException($this->errmsg);
}
}
}
|
