File: Validator.class

package info (click to toggle)
gforge 4.5.14-22etch13
  • links: PTS
  • area: main
  • in suites: etch
  • size: 13,004 kB
  • ctags: 11,918
  • sloc: php: 36,047; sql: 29,050; sh: 10,538; perl: 6,496; xml: 3,810; makefile: 341; python: 263; ansic: 256
file content (75 lines) | stat: -rw-r--r-- 2,006 bytes parent folder | download | duplicates (7)
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
<?php
/**
 * GForge Project Management Facility
 *
 * Copyright 2002 GForge, LLC
 * http://gforge.org/
 *
 * This file is part of GForge.
 *
 * GForge is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * GForge is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GForge; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  US
 */

/**
* This class is a simple utility to validate fields
* 
* Sample usage:
*
* $v = new Validator();
* $v->check($summary, "summary");
* $v->check($detail, "detail");
* if (!$v->isClean()) {
*  print $v->formErrorMsg("The following fields were null:");
* }
*
*/
class Validator {
	var $badfields;

	/**
	* Checks to see if a field is null; if so, the field name is added to an internal array
	*
	* @param field - a variable to check for null
	* @param name - the variable name
	*/
	function check($field, $name) {
		if (!$field) {
			$this->badfields[] = $name;
		}
	}

	/**
	* Returns true if no null fields have been checked so far
	*
	* @return boolean - True if there are no null fields so far
	*/
	function isClean() {
		return count($this->badfields) == 0;
	}
	
	/**
	* Returns an error message which contains the null field names which have been checked
	*
	* @param preamble string - A string with which to start the error message
	* @return string - A complete error message
	*/
	function formErrorMsg($preamble) {
		foreach ($this->badfields as $field) {
			$preamble = $preamble.$field.",";
		}
		return substr($preamble, 0, strlen($preamble)-1);
	}
}
?>