Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Validator

Class Validator

Generic validation class used throughout the Alpha Framework.

Namespace: Alpha\Util\Helper
Copyright:

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

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Util/Helper/Validator.php

Methods summary

public static boolean
# isInteger( $value )

Validate that the provided value is a valid integer.

Validate that the provided value is a valid integer.

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isDouble( $value )

Validate that the provided value is a valid double.

Validate that the provided value is a valid double.

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isBoolean( $value )

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

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

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isBooleanTrue( $value )

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

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

Parameters

$value

Returns

boolean

Since

2.0
public static boolean
# isAlpha( $value )

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

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

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isAlphaNum( $value )

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

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

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isSequence( $value )

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

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

Parameters

$value

Returns

boolean

Since

1.0
public static boolean
# isURL( $url )

Validate that the provided value is a valid URL.

Validate that the provided value is a valid URL.

Parameters

$url

Returns

boolean

Since

1.0
public static boolean
# isIP( $ip )

Validate that the provided value is a valid IP address.

Validate that the provided value is a valid IP address.

Parameters

$ip

Returns

boolean

Since

1.0
public static boolean
# isEmail( $email )

Validate that the provided value is a valid email address.

Validate that the provided value is a valid email address.

Parameters

$email

Returns

boolean

Since

1.0
public static boolean
# isBase64( $value )

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

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

Parameters

$value

Returns

boolean

Since

1.2.2
public static boolean
# isHTML( $value )

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

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

Parameters

$value

Returns

boolean

Since

2.0.1

Constants summary

string ALLOW_ALL

Allows any kind of input, including blanks.

Allows any kind of input, including blanks.

Since

1.0
# '/.*/i'
string REQUIRED_DOUBLE

Required double value.

Required double value.

Since

1.0
# '/^-{0,1}[0-9\.]+$/'
string REQUIRED_INTEGER

Required integer value.

Required integer value.

Since

1.0
# '/^-{0,1}[0-9]*$/'
string REQUIRED_TEXT

Required text value, accepts a maximum of 65536 characters.

Required text value, accepts a maximum of 65536 characters.

Since

1.0
# '/^[\S]{1}.{0,65535}$/'
string REQUIRED_STRING

Required string value, accepts a maximum of 255 characters.

Required string value, accepts a maximum of 255 characters.

Since

1.0
# '/^[\S]{1}.{0,254}$/'
string REQUIRED_ALPHA

Required alphabet string.

Required alphabet string.

Since

1.0
# '/^[a-zA-Z]+$/'
string REQUIRED_ALPHA_UPPER

Required uppercase alphabet string.

Required uppercase alphabet string.

Since

1.0
# '/^[A-Z]+$/'
string REQUIRED_ALPHA_NUMERIC

Required alpha-numeric string.

Required alpha-numeric string.

Since

1.0
# '/^[a-zA-Z0-9]+$/'
string REQUIRED_HTTP_URL

Required HTTP URL value.

Required HTTP URL value.

Since

1.0
# '/^((http|https):\/\/.*)$/i'
string OPTIONAL_HTTP_URL

Optional HTTP URL value.

Optional HTTP URL value.

Since

1.0
# '/(http|https).*|^$/i'
string REQUIRED_IP

Required IP address value.

Required IP address value.

Since

1.0
# '/^(((([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}))$/'
string REQUIRED_EMAIL

Required email address value.

Required email address value.

Since

1.0
# '/^[-_.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'
string REQUIRED_USERNAME

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

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

Since

1.0
# '/^[-_\.a-zA-Z0-9]+$/'
string REQUIRED_SEQUENCE

Required sequence value.

Required sequence value.

Since

1.0
# '/^[A-Z]*-[0-9]*$/'
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen