From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- zend/documentation/api/core/files/Validate.Ip.html | 110 +++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 zend/documentation/api/core/files/Validate.Ip.html (limited to 'zend/documentation/api/core/files/Validate.Ip.html') diff --git a/zend/documentation/api/core/files/Validate.Ip.html b/zend/documentation/api/core/files/Validate.Ip.html new file mode 100644 index 0000000..c5a0f92 --- /dev/null +++ b/zend/documentation/api/core/files/Validate.Ip.html @@ -0,0 +1,110 @@ + +Zend Gdata API Documentation

Validate/Ip.php

+ Show: + PublicProtectedPrivateinherited
+ Table of Contents +
Zend Framework

LICENSE

+ +

This source file is subject to the new BSD license that is bundled +with this package in the file LICENSE.txt. +It is also available through the world-wide-web at this URL: +http://framework.zend.com/license/new-bsd +If you did not receive a copy of the license and are unable to +obtain it through the world-wide-web, please send an email +to license@zend.com so we can send you a copy immediately.

Category
Zend +   +
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) +   +
License
New BSD License +   +
Package
Zend_Validate +   +
Version
$Id: Ip.php 24593 2012-01-05 20:35:02Z matthew $ +   +

\Zend_Validate_Ip
jump to top

Package: Zend\Validate
Parent(s)
\Zend_Validate_Abstract
Category
Zend +   +
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) +   +
License
New BSD License +   +

Constants

>VConstant  + INVALID + = 'ipInvalid'
>VConstant  + NOT_IP_ADDRESS + = 'notIpAddress'

Properties

>VPropertyprotected\Zend_Translate $_defaultTranslator
staticinherited
Default translation object for all validate objects
Inherited from: + \Zend_Validate_Abstract::$$_defaultTranslator
Details
Type
\Zend_Translate
Inherited_from
\Zend_Validate_Abstract::$$_defaultTranslator +   +
>VPropertyprotectedarray $_errors = array()
inherited
Array of validation failure message codes
Inherited from: + \Zend_Validate_Abstract::$$_errors
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_errors +   +
>VPropertyprotectedInteger $_messageLength = -1
staticinherited
Limits the maximum returned length of a error message
Inherited from: + \Zend_Validate_Abstract::$$_messageLength
Default value-1Details
Type
Integer
Inherited_from
\Zend_Validate_Abstract::$$_messageLength +   +
>VPropertyprotectedarray $_messageTemplates = array(self::INVALID => "Invalid type given. String expected", self::NOT_IP_ADDRESS => "'%value%' does not appear to be a valid IP address")
Validation failure message template definitions
Default valuearray(self::INVALID => "Invalid type given. String expected", self::NOT_IP_ADDRESS => "'%value%' does not appear to be a valid IP address")Details
Type
array
>VPropertyprotectedarray $_messageVariables = array()
inherited
Additional variables available for validation failure messages
Inherited from: + \Zend_Validate_Abstract::$$_messageVariables
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_messageVariables +   +
>VPropertyprotectedarray $_messages = array()
inherited
Array of validation failure messages
Inherited from: + \Zend_Validate_Abstract::$$_messages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_messages +   +
>VPropertyprotectedbool $_obscureValue = false
inherited
Flag indidcating whether or not value should be obfuscated in error +messages
Inherited from: + \Zend_Validate_Abstract::$$_obscureValue
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Validate_Abstract::$$_obscureValue +   +
>VPropertyprotectedarray $_options = array('allowipv6' => true, 'allowipv4' => true)
internal options
Default valuearray('allowipv6' => true, 'allowipv4' => true)Details
Type
array
>VPropertyprotected\Zend_Translate $_translator
inherited
Translation object
Inherited from: + \Zend_Validate_Abstract::$$_translator
Details
Type
\Zend_Translate
Inherited_from
\Zend_Validate_Abstract::$$_translator +   +
>VPropertyprotectedBoolean $_translatorDisabled = false
inherited
Is translation disabled?
Inherited from: + \Zend_Validate_Abstract::$$_translatorDisabled
Default valuefalseDetails
Type
Boolean
Inherited_from
\Zend_Validate_Abstract::$$_translatorDisabled +   +
>VPropertyprotectedmixed $_value
inherited
The value to be validated
Inherited from: + \Zend_Validate_Abstract::$$_value
Details
Type
mixed
Inherited_from
\Zend_Validate_Abstract::$$_value +   +

Methods

methodpublic__construct(array $options = array()) : void

Sets validator options

Parameters
NameTypeDescription
$optionsarray

OPTIONAL Options to set, see the manual for all available options

methodpublic__get(string $property) : mixed
inherited

Magic function returns the value of the requested property, if and only if it is the value or a +message variable.

Inherited from: + \Zend_Validate_Abstract::__get()
Parameters
NameTypeDescription
$propertystring
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Validate_Exception
methodprotected_createMessage(string $messageKey, string $value) : string
inherited

Constructs and returns a validation failure message with the given message key and value.

Inherited from: + \Zend_Validate_Abstract::_createMessage()

Returns null if and only if $messageKey does not correspond to an existing template.

+ +

If a translator is available and a translation exists for $messageKey, +the translation will be used.

Parameters
NameTypeDescription
$messageKeystring
$valuestring
Returns
TypeDescription
string
methodprotected_error(string $messageKey, string $value = null) : void
inherited

Inherited from: + \Zend_Validate_Abstract::_error()
Parameters
NameTypeDescription
$messageKeystring
$valuestring

OPTIONAL

methodprotected_setValue(mixed $value) : void
inherited

Sets the value to be validated and clears the messages and errors arrays

Inherited from: + \Zend_Validate_Abstract::_setValue()
Parameters
NameTypeDescription
$valuemixed
methodprotected_validateIPv4(string $value) : void

Validates an IPv4 address

Parameters
NameTypeDescription
$valuestring
methodprotected_validateIPv6(string $value) : boolean

Validates an IPv6 address

Parameters
NameTypeDescription
$valuestring

Value to check against

Returns
TypeDescription
booleanTrue when $value is a valid ipv6 address + False otherwise
methodpublicgetDefaultTranslator() : \Zend_Translate_Adapter | null
staticinherited

Get default translation object for all validate objects

Inherited from: + \Zend_Validate_Abstract::getDefaultTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublicgetErrors() : array
inherited

Returns array of validation failure message codes

Inherited from: + \Zend_Validate_Abstract::getErrors()
Returns
TypeDescription
array
methodpublicgetMessageLength() : integer
staticinherited

Returns the maximum allowed message length

Inherited from: + \Zend_Validate_Abstract::getMessageLength()
Returns
TypeDescription
integer
methodpublicgetMessageTemplates() : array
inherited

Returns the message templates from the validator

Inherited from: + \Zend_Validate_Abstract::getMessageTemplates()
Returns
TypeDescription
array
methodpublicgetMessageVariables() : array
inherited

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: + \Zend_Validate_Abstract::getMessageVariables()
Returns
TypeDescription
array
methodpublicgetMessages() : array
inherited

Returns array of validation failure messages

Inherited from: + \Zend_Validate_Abstract::getMessages()

The array keys are validation failure message identifiers, +and the array values are the corresponding human-readable message strings.

+ +

If isValid() was never called or if the most recent isValid() call +returned true, then this method returns an empty array.

Returns
TypeDescription
array
methodpublicgetObscureValue() : bool
inherited

Retrieve flag indicating whether or not value should be obfuscated in +messages

Inherited from: + \Zend_Validate_Abstract::getObscureValue()
Returns
TypeDescription
bool
methodpublicgetOptions() : array

Returns all set options

Returns
TypeDescription
array
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Return translation object

Inherited from: + \Zend_Validate_Abstract::getTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublichasDefaultTranslator() : boolean
staticinherited

Is there a default translation object set?

Inherited from: + \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
TypeDescription
boolean
methodpublichasTranslator() : bool
inherited

Does this validator have its own specific translator?

Inherited from: + \Zend_Validate_Abstract::hasTranslator()
Returns
TypeDescription
bool
methodpublicisValid(mixed $value) : boolean

Defined by Zend_Validate_Interface

Returns true if and only if $value is a valid IP address

Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicsetDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void
staticinherited

Set default translation object for all validate objects

Inherited from: + \Zend_Validate_Abstract::setDefaultTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
methodpublicsetDisableTranslator(bool $flag) : \Zend_Validate_Abstract
inherited

Indicate whether or not translation should be disabled

Inherited from: + \Zend_Validate_Abstract::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
inherited

Sets the validation failure message template for a particular key

Inherited from: + \Zend_Validate_Abstract::setMessage()
Parameters
NameTypeDescription
$messageStringstring
$messageKeystring

OPTIONAL

Returns
TypeDescription
\Zend_Validate_AbstractProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_Exception
methodpublicsetMessageLength(integer $length = -1) : void
staticinherited

Sets the maximum allowed message length

Inherited from: + \Zend_Validate_Abstract::setMessageLength()
Parameters
NameTypeDescription
$lengthinteger
methodpublicsetMessages(array $messages) : \Zend_Validate_Abstract
inherited

Sets validation failure message templates given as an array, where the array keys are the message keys, +and the array values are the message template strings.

Inherited from: + \Zend_Validate_Abstract::setMessages()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetObscureValue(bool $flag) : \Zend_Validate_Abstract
inherited

Set flag indicating whether or not value should be obfuscated in messages

Inherited from: + \Zend_Validate_Abstract::setObscureValue()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetOptions(array $options) : \Zend_Validate_Ip

Sets the options for this validator

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Validate_Ip
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract
inherited

Set translation object

Inherited from: + \Zend_Validate_Abstract::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublictranslatorIsDisabled() : bool
inherited

Is translation disabled?

Inherited from: + \Zend_Validate_Abstract::translatorIsDisabled()
Returns
TypeDescription
bool
+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3