Alpha Framework 3.1.0 API Documentation

Validator

Generic validation class used throughout the Alpha Framework.

Tags

since

1.0

author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2019, 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.

Table of Contents

ALLOW_ALL  = '/.*/i'

Allows any kind of input, including blanks.

OPTIONAL_HTTP_URL  = '/(http|https).*|^$/i'

Optional HTTP URL value.

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

Required alphabet string.

REQUIRED_ALPHA_NUMERIC  = '/^[a-zA-Z0-9]+$/'

Required alpha-numeric string.

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

Required uppercase alphabet string.

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

Required double value.

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|email|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'

Required email address value.

REQUIRED_HTTP_URL  = '/^((http|https):\/\/.*)$/i'

Required HTTP URL value.

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

Required integer value.

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}))$/'

Required IP address value.

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

Required sequence value.

REQUIRED_STRING  = '/^[\S]{1}.{0,254}$/'

Required string value, accepts a maximum of 255 characters.

REQUIRED_TEXT  = '/^[\S]{1}.{0,65535}$/'

Required text value, accepts a maximum of 65536 characters.

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

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

isAlpha()  : bool

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

isAlphaNum()  : bool

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

isBase64()  : bool

Validate that the provided value is base64 encoded (best guess by regex).

isBoolean()  : bool

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

isBooleanTrue()  : bool

Validate that the provided value is a valid boolean true or not (true, 'true', 1, '1', 'on').

isDouble()  : bool

Validate that the provided value is a valid double.

isEmail()  : bool

Validate that the provided value is a valid email address.

isHTML()  : bool

Will return true if the value provided contains any HTML code that is stripable by the native strip_tags() function.

isInteger()  : bool

Validate that the provided value is a valid integer.

isIP()  : bool

Validate that the provided value is a valid IP address.

isSequence()  : bool

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

isURL()  : bool

Validate that the provided value is a valid URL.