Alpha Framework alpha--util--helpers
[ class tree: alpha--util--helpers ] [ index: alpha--util--helpers ] [ all elements ]

Class: AlphaValidator

Source Location: /util/helpers/AlphaValidator.inc

Class AlphaValidator

Class Overview

Generic validation class used throughout the Alpha Framework

Located in /util/helpers/AlphaValidator.inc [line 47]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: AlphaValidator.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 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 HOLDER 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.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Constant Summary
ALLOW_ALL   Allows any kind of input, including blanks
OPTIONAL_HTTP_URL   Optional HTTP URL value
REQUIRED_ALPHA   Required alphabet string
REQUIRED_ALPHA_NUMBEIC   Required alpha-numeric string
REQUIRED_ALPHA_UPPER   Required uppercase alphabet string
REQUIRED_DOUBLE   Required double value
REQUIRED_EMAIL   Required email address value
REQUIRED_HTTP_URL   Required HTTP URL value
REQUIRED_INTEGER   Required integer value
REQUIRED_IP   Required IP address value
REQUIRED_SEQUENCE   Required sequence value
REQUIRED_STRING   Required string value, accepts a maximum of 255 characters
REQUIRED_TEXT   Required text value, accepts a maximum of 65536 characters
REQUIRED_USERNAME   Required username (allows a-z A-Z 0-9 and -_. characters)

[ Top ]
Method Summary
static boolean   isAlpha()   Validate that the provided value is a valid alphabetic string (strictly a-zA-Z)
static boolean   isAlphaNum()   Validate that the provided value is a valid alpha-numeric string (strictly a-zA-Z0-9)
static boolean   isBoolean()   Validate that the provided value is a valid boolean (will accept 1 or 0 as valid booleans)
static boolean   isDouble()   Validate that the provided value is a valid double
static boolean   isInteger()   Validate that the provided value is a valid integer
static boolean   isIP()   Validate that the provided value is a valid IP address
static boolean   isSequence()   Validate that the provided value is a valid Sequence string ([A-Z]-[0-9])
static boolean   isURL()   Validate that the provided value is a valid URL
boolean   isEmail()   Validate that the provided value is a valid email address

[ Top ]
Methods
static method isAlpha  [line 211]

  static boolean isAlpha( $value $value  )

Validate that the provided value is a valid alphabetic string (strictly a-zA-Z)

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isAlphaNum  [line 225]

  static boolean isAlphaNum( $value $value  )

Validate that the provided value is a valid alpha-numeric string (strictly a-zA-Z0-9)

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isBoolean  [line 195]

  static boolean isBoolean( $value $value  )

Validate that the provided value is a valid boolean (will accept 1 or 0 as valid booleans)

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isDouble  [line 181]

  static boolean isDouble( $value $value  )

Validate that the provided value is a valid double

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isInteger  [line 167]

  static boolean isInteger( $value $value  )

Validate that the provided value is a valid integer

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isIP  [line 271]

  static boolean isIP( $value $ip  )

Validate that the provided value is a valid IP address

Parameters:
$value   $ip: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isSequence  [line 239]

  static boolean isSequence( $value $value  )

Validate that the provided value is a valid Sequence string ([A-Z]-[0-9])

Parameters:
$value   $value: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
static method isURL  [line 253]

  static boolean isURL( $value $url  )

Validate that the provided value is a valid URL

Parameters:
$value   $url: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
isEmail  [line 289]

  boolean isEmail( $value $email  )

Validate that the provided value is a valid email address

Parameters:
$value   $email: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
Constants
ALLOW_ALL = '/.*/i' [line 54]

Allows any kind of input, including blanks

Information Tags:
Since:  1.0

[ Top ]
OPTIONAL_HTTP_URL = '/http.*|^$/i' [line 126]

Optional HTTP URL value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_ALPHA = '/^[a-zA-Z]+$/' [line 94]

Required alphabet string

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_ALPHA_NUMBEIC = '/^[a-zA-Z0-9]+$/' [line 110]

Required alpha-numeric string

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_ALPHA_UPPER = '/^[A-Z]+$/' [line 102]

Required uppercase alphabet string

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_DOUBLE = '/^-{0,1}[0-9\.]+$/' [line 62]

Required double value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_EMAIL = '/^[-_.a-zA-Z0-9]+@((([a-zA-Z0-9]|[-_.a-zA-Z0-9]*[a-zA-Z0-9])\.)+(ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|at|au|aw|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|com|coop|cr|cs|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gh|gi|gl|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|in|info|int|io|iq|ir|is|it|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mil|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no|np|nr|nt|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)|(([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5])\.){3}([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5]))$/i' [line 142]

Required email address value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_HTTP_URL = '/^(http:\/\/.*)$/i' [line 118]

Required HTTP URL value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_INTEGER = '/^-{0,1}[0-9]*$/' [line 70]

Required integer value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_IP = '/^(((([1-9])|([1-9][\d])|(1[\d]{2})|(2[0-4][\d])|(25[0-4]))(\.(([\d])|([1-9][\d])|(1[\d]{2})|(2[0-4][\d])|(25[0-4]))){3})|(0(\.0){3}))$/' [line 134]

Required IP address value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_SEQUENCE = '/^[A-Z]*-[0-9]*$/' [line 158]

Required sequence value

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_STRING = '/^[a-z\d\.,\'][a-z\d\.,\' ]{0,255}$/i' [line 86]

Required string value, accepts a maximum of 255 characters

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_TEXT = '/^[a-z\d\.,\'][a-z\d\.,\' ]{0,65535}$/i' [line 78]

Required text value, accepts a maximum of 65536 characters

Information Tags:
Since:  1.0

[ Top ]
REQUIRED_USERNAME = '/^[-_\.a-zA-Z0-9]+$/' [line 150]

Required username (allows a-z A-Z 0-9 and -_. characters)

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:26:16 +0000 by phpDocumentor 1.4.3