Class Ip

Responsibility: Validate if a submitted value is an IP address. It supports the IPv4, IPv6 and IPvFeature definitions.

MvcCore\Ext\Forms\Validator implements MvcCore\Ext\Forms\IValidator

MvcCore\Ext\Forms\Validators\Ip

Namespace: MvcCore\Ext\Forms\Validators
Located at ext-form-validator-special/src/MvcCore/Ext/Forms/Validators/Ip.php

Methods summary
`public boolean`	# `GetAllowIPv4OctetFormat( )` Get `TRUE`, if validation for IPv4 address is allowed in octet format. Octet format is `0-255.0-255.0-255.0-255`. Default value is `TRUE`. Get `TRUE`, if validation for IPv4 address is allowed in octet format. Octet format is `0-255.0-255.0-255.0-255`. Default value is `TRUE`. Returns boolean
`public MvcCore\Ext\Forms\Validators\Ip`	# `SetAllowIPv4OctetFormat( boolean $allowIPv4OctetFormat = TRUE )` Set `TRUE` to allow IPv4 address validation in octet format. Octet format is `0-255.0-255.0-255.0-255`. Default value is `TRUE`. Set `TRUE` to allow IPv4 address validation in octet format. Octet format is `0-255.0-255.0-255.0-255`. Default value is `TRUE`. Parameters `$allowIPv4OctetFormat` Returns `MvcCore\Ext\Forms\Validators\Ip`
`public boolean`	# `GetAllowIPv4HexFormat( )` Get `TRUE`, if validation for IPv4 address is allowed in hexadecimal format. Hexadecimal format is `00-FF.00-FF.00-FF.00-FF`. Default value is `FALSE`. Get `TRUE`, if validation for IPv4 address is allowed in hexadecimal format. Hexadecimal format is `00-FF.00-FF.00-FF.00-FF`. Default value is `FALSE`. Returns boolean
`public MvcCore\Ext\Forms\Validators\Ip`	# `SetAllowIPv4HexFormat( boolean $allowIPv4HexFormat = TRUE )` Set `TRUE` to allow IPv4 address validation in hexadecimal format. Hexadecimal format is `00-FF.00-FF.00-FF.00-FF`. Default value is `FALSE`. Set `TRUE` to allow IPv4 address validation in hexadecimal format. Hexadecimal format is `00-FF.00-FF.00-FF.00-FF`. Default value is `FALSE`. Parameters `$allowIPv4HexFormat` Returns `MvcCore\Ext\Forms\Validators\Ip`
`public boolean`	# `GetAllowIPv4BinaryFormat( )` Get `TRUE`, if validation for IPv4 address is allowed in binary format. Binary format is: `00000000-11111111.00000000-11111111.00000000-11111111.00000000-11111111`. Default value is `FALSE`. Get `TRUE`, if validation for IPv4 address is allowed in binary format. Binary format is: `00000000-11111111.00000000-11111111.00000000-11111111.00000000-11111111`. Default value is `FALSE`. Returns boolean
`public MvcCore\Ext\Forms\Validators\Ip`	# `SetAllowIPv4BinaryFormat( boolean $allowIPv4BinaryFormat = TRUE )` Set `TRUE` to allow IPv4 address validation in binary format.Binary format is: `00000000-11111111.00000000-11111111.00000000-11111111.00000000-11111111`. Default value is `FALSE`. Set `TRUE` to allow IPv4 address validation in binary format.Binary format is: `00000000-11111111.00000000-11111111.00000000-11111111.00000000-11111111`. Default value is `FALSE`. Parameters `$allowIPv4BinaryFormat` Returns `MvcCore\Ext\Forms\Validators\Ip`
`public boolean`	# `GetAllowIPv6( )` Get `TRUE`, if validation of IPv6 is allowed. Default value is `TRUE`. Get `TRUE`, if validation of IPv6 is allowed. Default value is `TRUE`. Returns boolean
`public MvcCore\Ext\Forms\Validators\Ip`	# `SetAllowIPv6( boolean $allowIPv6 = TRUE )` Set `TRUE` to allow IPv6 validation. Default value is `TRUE`. Set `TRUE` to allow IPv6 validation. Default value is `TRUE`. Parameters `$allowIPv6` Returns `MvcCore\Ext\Forms\Validators\Ip`
`public boolean`	# `GetAllowIPv6Literals( )` Get `TRUE` if IPV6 validation allows literals. Default value is `FALSE`. Get `TRUE` if IPV6 validation allows literals. Default value is `FALSE`. Returns boolean See https://en.wikipedia.org/wiki/IPv6_address#Literal_IPv6_addresses_in_network_resource_identifiers
`public MvcCore\Ext\Forms\Validators\Ip`	# `SetAllowIPv6Literals( boolean $allowIPv6Literals = TRUE )` Set `TRUE` to allow literals in IPV6 validation. Default value is `FALSE`. Set `TRUE` to allow literals in IPV6 validation. Default value is `FALSE`. Parameters `$allowIPv6Literals` Returns `MvcCore\Ext\Forms\Validators\Ip` See https://en.wikipedia.org/wiki/IPv6_address#Literal_IPv6_addresses_in_network_resource_identifiers
`public string\|null`	# `Validate( string\|array $rawSubmittedValue )` Validate raw user input with maximum string length check. Validate raw user input with maximum string length check. Parameters `$rawSubmittedValue` $submitValue Raw submitted value from user. Returns string\|null Safe submitted value or `NULL` if not possible to return safe value.
`protected string\|null`	# `validateIPv4( string $rawSubmittedValue )` Validate IPv4 address format. Validate IPv4 address format. Parameters `$rawSubmittedValue` Returns string\|null
`protected string\|null`	# `validateIPv6( string $rawSubmittedValue )` Validate IPv6 address format. Validate IPv6 address format. Parameters `$rawSubmittedValue` Returns string\|null

Methods inherited from MvcCore\Ext\Forms\Validator
`CreateInstance(), GetErrorMessage(), SetField(), SetForm(), __construct(), setUpFieldProps(), throwNewInvalidArgumentException()`

Constants summary
`integer`	`ERROR_IP` Error message index(es). Error message index(es).	# `0`

Properties summary
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# `[ self::ERROR_IP => "Field '{0}' requires a valid IP address. Allowed types: {1}.", ]`
`protected boolean`	`$allowIPv4OctetFormat` Allow IPv4 validation in octet format. Default value is `TRUE`. Allow IPv4 validation in octet format. Default value is `TRUE`.	# `TRUE`
`protected boolean`	`$allowIPv4HexFormat` Allow IPv4 validation in hexadecimal format. Default value is `FALSE`. Allow IPv4 validation in hexadecimal format. Default value is `FALSE`.	# `FALSE`
`protected boolean`	`$allowIPv4BinaryFormat` Allow IPv4 validation in binary format. Default value is `FALSE`. Allow IPv4 validation in binary format. Default value is `FALSE`.	# `FALSE`
`protected boolean`	`$allowIPv6` Allow IPv6 validation. Default value is `TRUE`. Allow IPv6 validation. Default value is `TRUE`.	# `TRUE`
`protected mixed`	`$allowIPv6Literals` Allow IPV6 literals. Default value is `FALSE`. Allow IPV6 literals. Default value is `FALSE`. See https://en.wikipedia.org/wiki/IPv6_address#Literal_IPv6_addresses_in_network_resource_identifiers	# `FALSE`

Properties inherited from MvcCore\Ext\Forms\Validator
`$field, $fieldSpecificProperties, $form, $toolClass`

Classes

Interfaces

Traits

Exceptions

Functions

Class Ip

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

See