From e35ac6cedbbde2c388900b621dc1f1a9a3085bb3 Mon Sep 17 00:00:00 2001 From: Philip Lehmann-Boehm Date: Tue, 30 Aug 2016 11:46:40 +0200 Subject: [PATCH] added some missing API docs and fixed some typos --- docs/api/RulesBuilder.rst | 6 +- docs/api/ValidationException.rst | 6 +- docs/api/Validator.rst | 6 +- docs/api/Validator/AbstractComparator.rst | 8 +- .../Validator/AbstractDateTimeComparator.rst | 10 +- docs/api/Validator/AbstractFilter.rst | 12 +- .../AbstractParametrizedValidator.rst | 14 ++- docs/api/Validator/AfterDateTime.rst | 10 +- docs/api/Validator/AlphaNumerical.rst | 8 +- docs/api/Validator/Alphabetical.rst | 8 +- docs/api/Validator/BeforeDateTime.rst | 10 +- docs/api/Validator/Between.rst | 8 +- docs/api/Validator/Boolean.rst | 6 +- docs/api/Validator/Contains.rst | 8 +- docs/api/Validator/DateTime.rst | 6 +- docs/api/Validator/DateTimeBetween.rst | 4 +- docs/api/Validator/Email.rst | 6 +- docs/api/Validator/Floating.rst | 6 +- docs/api/Validator/IP.rst | 6 +- docs/api/Validator/IPv4.rst | 6 +- docs/api/Validator/IPv6.rst | 6 +- docs/api/Validator/InSet.rst | 6 +- docs/api/Validator/InTheFuture.rst | 10 +- docs/api/Validator/InThePast.rst | 10 +- docs/api/Validator/Integer.rst | 6 +- docs/api/Validator/LengthBetween.rst | 8 +- docs/api/Validator/Max.rst | 8 +- docs/api/Validator/MaxLength.rst | 8 +- docs/api/Validator/Min.rst | 8 +- docs/api/Validator/MinLength.rst | 8 +- docs/api/Validator/OlderThan.rst | 10 +- docs/api/Validator/OrCombine.rst | 6 +- docs/api/Validator/Regexp.rst | 8 +- docs/api/Validator/Required.rst | 6 +- docs/api/Validator/Slug.rst | 8 +- docs/api/Validator/Url.rst | 6 +- docs/api/Validator/ValidatorInterface.rst | 6 +- docs/api/Validator/Value.rst | 8 +- docs/api/Validator/YoungerThan.rst | 10 +- docs/api/ValidatorException.rst | 6 +- .../html/0.10.0/_sources/api/RulesBuilder.txt | 6 +- .../_sources/api/ValidationException.txt | 6 +- docs/html/0.10.0/_sources/api/Validator.txt | 6 +- .../api/Validator/AbstractComparator.txt | 8 +- .../Validator/AbstractDateTimeComparator.txt | 10 +- .../_sources/api/Validator/AbstractFilter.txt | 12 +- .../AbstractParametrizedValidator.txt | 14 ++- .../_sources/api/Validator/AfterDateTime.txt | 10 +- .../_sources/api/Validator/AlphaNumerical.txt | 8 +- .../_sources/api/Validator/Alphabetical.txt | 8 +- .../_sources/api/Validator/BeforeDateTime.txt | 10 +- .../0.10.0/_sources/api/Validator/Between.txt | 8 +- .../0.10.0/_sources/api/Validator/Boolean.txt | 6 +- .../_sources/api/Validator/Contains.txt | 8 +- .../_sources/api/Validator/DateTime.txt | 6 +- .../api/Validator/DateTimeBetween.txt | 4 +- .../0.10.0/_sources/api/Validator/Email.txt | 6 +- .../_sources/api/Validator/Floating.txt | 6 +- .../html/0.10.0/_sources/api/Validator/IP.txt | 6 +- .../0.10.0/_sources/api/Validator/IPv4.txt | 6 +- .../0.10.0/_sources/api/Validator/IPv6.txt | 6 +- .../0.10.0/_sources/api/Validator/InSet.txt | 6 +- .../_sources/api/Validator/InTheFuture.txt | 10 +- .../_sources/api/Validator/InThePast.txt | 10 +- .../0.10.0/_sources/api/Validator/Integer.txt | 6 +- .../_sources/api/Validator/LengthBetween.txt | 8 +- .../0.10.0/_sources/api/Validator/Max.txt | 8 +- .../_sources/api/Validator/MaxLength.txt | 8 +- .../0.10.0/_sources/api/Validator/Min.txt | 8 +- .../_sources/api/Validator/MinLength.txt | 8 +- .../_sources/api/Validator/OlderThan.txt | 10 +- .../_sources/api/Validator/OrCombine.txt | 6 +- .../0.10.0/_sources/api/Validator/Regexp.txt | 8 +- .../_sources/api/Validator/Required.txt | 6 +- .../0.10.0/_sources/api/Validator/Slug.txt | 8 +- .../0.10.0/_sources/api/Validator/Url.txt | 6 +- .../api/Validator/ValidatorInterface.txt | 6 +- .../0.10.0/_sources/api/Validator/Value.txt | 8 +- .../_sources/api/Validator/YoungerThan.txt | 10 +- .../_sources/api/ValidatorException.txt | 6 +- .../0.10.0/_sources/manual/validators.txt | 4 +- docs/html/0.10.0/api/RulesBuilder.html | 40 +++---- docs/html/0.10.0/api/ValidationException.html | 44 ++++--- docs/html/0.10.0/api/Validator.html | 44 ++++--- .../api/Validator/AbstractComparator.html | 96 ++++++++-------- .../Validator/AbstractDateTimeComparator.html | 80 ++++++------- .../0.10.0/api/Validator/AbstractFilter.html | 86 ++++++++------ .../AbstractParametrizedValidator.html | 106 +++++++++-------- .../0.10.0/api/Validator/AfterDateTime.html | 70 ++++++------ .../0.10.0/api/Validator/AlphaNumerical.html | 82 +++++++------ .../0.10.0/api/Validator/Alphabetical.html | 82 +++++++------ .../0.10.0/api/Validator/BeforeDateTime.html | 66 +++++------ docs/html/0.10.0/api/Validator/Between.html | 74 ++++++------ docs/html/0.10.0/api/Validator/Boolean.html | 44 ++++--- docs/html/0.10.0/api/Validator/Contains.html | 74 ++++++------ docs/html/0.10.0/api/Validator/DateTime.html | 44 ++++--- .../0.10.0/api/Validator/DateTimeBetween.html | 62 +++++----- docs/html/0.10.0/api/Validator/Email.html | 62 +++++----- docs/html/0.10.0/api/Validator/Floating.html | 62 +++++----- docs/html/0.10.0/api/Validator/IP.html | 62 +++++----- docs/html/0.10.0/api/Validator/IPv4.html | 62 +++++----- docs/html/0.10.0/api/Validator/IPv6.html | 62 +++++----- docs/html/0.10.0/api/Validator/InSet.html | 44 ++++--- .../0.10.0/api/Validator/InTheFuture.html | 66 +++++------ docs/html/0.10.0/api/Validator/InThePast.html | 70 ++++++------ docs/html/0.10.0/api/Validator/Integer.html | 62 +++++----- .../0.10.0/api/Validator/LengthBetween.html | 74 ++++++------ docs/html/0.10.0/api/Validator/Max.html | 74 ++++++------ docs/html/0.10.0/api/Validator/MaxLength.html | 74 ++++++------ docs/html/0.10.0/api/Validator/Min.html | 74 ++++++------ docs/html/0.10.0/api/Validator/MinLength.html | 74 ++++++------ docs/html/0.10.0/api/Validator/OlderThan.html | 70 ++++++------ docs/html/0.10.0/api/Validator/OrCombine.html | 50 ++++---- docs/html/0.10.0/api/Validator/Regexp.html | 86 +++++++------- docs/html/0.10.0/api/Validator/Required.html | 44 ++++--- docs/html/0.10.0/api/Validator/Slug.html | 82 +++++++------ docs/html/0.10.0/api/Validator/Url.html | 62 +++++----- .../api/Validator/ValidatorInterface.html | 44 ++++--- docs/html/0.10.0/api/Validator/Value.html | 74 ++++++------ .../0.10.0/api/Validator/YoungerThan.html | 70 ++++++------ docs/html/0.10.0/api/ValidatorException.html | 40 +++---- docs/html/0.10.0/genindex.html | 36 +++--- docs/html/0.10.0/index.html | 108 +++++++++--------- docs/html/0.10.0/manual/validators.html | 32 +++--- docs/html/0.10.0/objects.inv | Bin 1868 -> 1877 bytes docs/html/0.10.0/search.html | 26 ++--- docs/html/0.10.0/searchindex.js | 2 +- docs/manual/validators.rst | 4 +- src/Valdi/Validator.php | 3 + .../Validator/AbstractDateTimeComparator.php | 5 +- .../AbstractParametrizedValidator.php | 5 +- src/Valdi/Validator/Contains.php | 5 +- src/Valdi/Validator/OrCombine.php | 5 +- 133 files changed, 1696 insertions(+), 1789 deletions(-) diff --git a/docs/api/RulesBuilder.rst b/docs/api/RulesBuilder.rst index 15d290b..fbb82e6 100644 --- a/docs/api/RulesBuilder.rst +++ b/docs/api/RulesBuilder.rst @@ -1,6 +1,6 @@ ------------- -RulesBuilder ------------- +------------------- +Valdi\\RulesBuilder +------------------- .. php:namespace: Valdi diff --git a/docs/api/ValidationException.rst b/docs/api/ValidationException.rst index 9aae73f..a49887d 100644 --- a/docs/api/ValidationException.rst +++ b/docs/api/ValidationException.rst @@ -1,6 +1,6 @@ -------------------- -ValidationException -------------------- +-------------------------- +Valdi\\ValidationException +-------------------------- .. php:namespace: Valdi diff --git a/docs/api/Validator.rst b/docs/api/Validator.rst index f7be304..f01c9d6 100644 --- a/docs/api/Validator.rst +++ b/docs/api/Validator.rst @@ -1,6 +1,6 @@ ---------- -Validator ---------- +---------------- +Valdi\\Validator +---------------- .. php:namespace: Valdi diff --git a/docs/api/Validator/AbstractComparator.rst b/docs/api/Validator/AbstractComparator.rst index e883d27..4ba1b14 100644 --- a/docs/api/Validator/AbstractComparator.rst +++ b/docs/api/Validator/AbstractComparator.rst @@ -1,6 +1,6 @@ ------------------------------ -Validator\\AbstractComparator ------------------------------ +------------------------------------ +Valdi\\Validator\\AbstractComparator +------------------------------------ .. toctree:: @@ -61,7 +61,7 @@ Validator\\AbstractComparator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/AbstractDateTimeComparator.rst b/docs/api/Validator/AbstractDateTimeComparator.rst index c350658..9811cbf 100644 --- a/docs/api/Validator/AbstractDateTimeComparator.rst +++ b/docs/api/Validator/AbstractDateTimeComparator.rst @@ -1,6 +1,6 @@ -------------------------------------- -Validator\\AbstractDateTimeComparator -------------------------------------- +-------------------------------------------- +Valdi\\Validator\\AbstractDateTimeComparator +-------------------------------------------- .. toctree:: @@ -64,7 +64,7 @@ Validator\\AbstractDateTimeComparator Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -82,7 +82,7 @@ Validator\\AbstractDateTimeComparator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/AbstractFilter.rst b/docs/api/Validator/AbstractFilter.rst index 20757a9..8ca6962 100644 --- a/docs/api/Validator/AbstractFilter.rst +++ b/docs/api/Validator/AbstractFilter.rst @@ -1,6 +1,6 @@ -------------------------- -Validator\\AbstractFilter -------------------------- +-------------------------------- +Valdi\\Validator\\AbstractFilter +-------------------------------- .. toctree:: @@ -38,3 +38,9 @@ Validator\\AbstractFilter :param $value: :param $parameters: + + .. php:method:: getInvalidDetails() + + Gets the details if the validation failed. + + :returns: mixed the details diff --git a/docs/api/Validator/AbstractParametrizedValidator.rst b/docs/api/Validator/AbstractParametrizedValidator.rst index e2ba2b5..49f465e 100644 --- a/docs/api/Validator/AbstractParametrizedValidator.rst +++ b/docs/api/Validator/AbstractParametrizedValidator.rst @@ -1,6 +1,6 @@ ----------------------------------------- -Validator\\AbstractParametrizedValidator ----------------------------------------- +----------------------------------------------- +Valdi\\Validator\\AbstractParametrizedValidator +----------------------------------------------- .. toctree:: @@ -15,7 +15,7 @@ Validator\\AbstractParametrizedValidator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string @@ -34,3 +34,9 @@ Validator\\AbstractParametrizedValidator :type $parameters: array :param $parameters: the other parameters the validator might need :returns: boolean true if the value is valid, false else + + .. php:method:: getInvalidDetails() + + Gets the details if the validation failed. + + :returns: mixed the details diff --git a/docs/api/Validator/AfterDateTime.rst b/docs/api/Validator/AfterDateTime.rst index d43fef2..008d857 100644 --- a/docs/api/Validator/AfterDateTime.rst +++ b/docs/api/Validator/AfterDateTime.rst @@ -1,6 +1,6 @@ ------------------------- -Validator\\AfterDateTime ------------------------- +------------------------------- +Valdi\\Validator\\AfterDateTime +------------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\AfterDateTime Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\AfterDateTime .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/AlphaNumerical.rst b/docs/api/Validator/AlphaNumerical.rst index d997a54..5a67abd 100644 --- a/docs/api/Validator/AlphaNumerical.rst +++ b/docs/api/Validator/AlphaNumerical.rst @@ -1,6 +1,6 @@ -------------------------- -Validator\\AlphaNumerical -------------------------- +-------------------------------- +Valdi\\Validator\\AlphaNumerical +-------------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\AlphaNumerical .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Alphabetical.rst b/docs/api/Validator/Alphabetical.rst index 162a719..a2b7568 100644 --- a/docs/api/Validator/Alphabetical.rst +++ b/docs/api/Validator/Alphabetical.rst @@ -1,6 +1,6 @@ ------------------------ -Validator\\Alphabetical ------------------------ +------------------------------ +Valdi\\Validator\\Alphabetical +------------------------------ .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Alphabetical .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/BeforeDateTime.rst b/docs/api/Validator/BeforeDateTime.rst index ac35bc7..a2216c3 100644 --- a/docs/api/Validator/BeforeDateTime.rst +++ b/docs/api/Validator/BeforeDateTime.rst @@ -1,6 +1,6 @@ -------------------------- -Validator\\BeforeDateTime -------------------------- +-------------------------------- +Valdi\\Validator\\BeforeDateTime +-------------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\BeforeDateTime Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\BeforeDateTime .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Between.rst b/docs/api/Validator/Between.rst index 05dde49..2ccbe34 100644 --- a/docs/api/Validator/Between.rst +++ b/docs/api/Validator/Between.rst @@ -1,6 +1,6 @@ ------------------- -Validator\\Between ------------------- +------------------------- +Valdi\\Validator\\Between +------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Between .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Boolean.rst b/docs/api/Validator/Boolean.rst index f38c60a..4d1980d 100644 --- a/docs/api/Validator/Boolean.rst +++ b/docs/api/Validator/Boolean.rst @@ -1,6 +1,6 @@ ------------------- -Validator\\Boolean ------------------- +------------------------- +Valdi\\Validator\\Boolean +------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/Contains.rst b/docs/api/Validator/Contains.rst index c1a6999..6f21a25 100644 --- a/docs/api/Validator/Contains.rst +++ b/docs/api/Validator/Contains.rst @@ -1,6 +1,6 @@ -------------------- -Validator\\Contains -------------------- +-------------------------- +Valdi\\Validator\\Contains +-------------------------- .. php:namespace: Valdi\\Validator @@ -10,7 +10,7 @@ Validator\\Contains .. php:method:: validateParameterCount($parameterAmount) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $parameterAmount: integer diff --git a/docs/api/Validator/DateTime.rst b/docs/api/Validator/DateTime.rst index d93c916..9cc8bec 100644 --- a/docs/api/Validator/DateTime.rst +++ b/docs/api/Validator/DateTime.rst @@ -1,6 +1,6 @@ -------------------- -Validator\\DateTime -------------------- +-------------------------- +Valdi\\Validator\\DateTime +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/DateTimeBetween.rst b/docs/api/Validator/DateTimeBetween.rst index 49b3e5a..eff1a54 100644 --- a/docs/api/Validator/DateTimeBetween.rst +++ b/docs/api/Validator/DateTimeBetween.rst @@ -51,7 +51,7 @@ Valdi\\Validator\\DateTimeBetween Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Valdi\\Validator\\DateTimeBetween .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Email.rst b/docs/api/Validator/Email.rst index f495d8a..7d4c49b 100644 --- a/docs/api/Validator/Email.rst +++ b/docs/api/Validator/Email.rst @@ -1,6 +1,6 @@ ----------------- -Validator\\Email ----------------- +----------------------- +Valdi\\Validator\\Email +----------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/Floating.rst b/docs/api/Validator/Floating.rst index bc59ca4..0bf06c7 100644 --- a/docs/api/Validator/Floating.rst +++ b/docs/api/Validator/Floating.rst @@ -1,6 +1,6 @@ -------------------- -Validator\\Floating -------------------- +-------------------------- +Valdi\\Validator\\Floating +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/IP.rst b/docs/api/Validator/IP.rst index 91a0852..d23a1b9 100644 --- a/docs/api/Validator/IP.rst +++ b/docs/api/Validator/IP.rst @@ -1,6 +1,6 @@ -------------- -Validator\\IP -------------- +-------------------- +Valdi\\Validator\\IP +-------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/IPv4.rst b/docs/api/Validator/IPv4.rst index 30e81a1..f5b46d8 100644 --- a/docs/api/Validator/IPv4.rst +++ b/docs/api/Validator/IPv4.rst @@ -1,6 +1,6 @@ ---------------- -Validator\\IPv4 ---------------- +---------------------- +Valdi\\Validator\\IPv4 +---------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/IPv6.rst b/docs/api/Validator/IPv6.rst index 0fe4d63..9a56ffb 100644 --- a/docs/api/Validator/IPv6.rst +++ b/docs/api/Validator/IPv6.rst @@ -1,6 +1,6 @@ ---------------- -Validator\\IPv6 ---------------- +---------------------- +Valdi\\Validator\\IPv6 +---------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/InSet.rst b/docs/api/Validator/InSet.rst index 0c824bc..3222882 100644 --- a/docs/api/Validator/InSet.rst +++ b/docs/api/Validator/InSet.rst @@ -1,6 +1,6 @@ ----------------- -Validator\\InSet ----------------- +----------------------- +Valdi\\Validator\\InSet +----------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/InTheFuture.rst b/docs/api/Validator/InTheFuture.rst index 26998c9..28b54a0 100644 --- a/docs/api/Validator/InTheFuture.rst +++ b/docs/api/Validator/InTheFuture.rst @@ -1,6 +1,6 @@ ----------------------- -Validator\\InTheFuture ----------------------- +----------------------------- +Valdi\\Validator\\InTheFuture +----------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\InTheFuture Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\InTheFuture .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/InThePast.rst b/docs/api/Validator/InThePast.rst index 938e2a9..759f779 100644 --- a/docs/api/Validator/InThePast.rst +++ b/docs/api/Validator/InThePast.rst @@ -1,6 +1,6 @@ --------------------- -Validator\\InThePast --------------------- +--------------------------- +Valdi\\Validator\\InThePast +--------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\InThePast Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\InThePast .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Integer.rst b/docs/api/Validator/Integer.rst index aae3cf0..02f4fe8 100644 --- a/docs/api/Validator/Integer.rst +++ b/docs/api/Validator/Integer.rst @@ -1,6 +1,6 @@ ------------------- -Validator\\Integer ------------------- +------------------------- +Valdi\\Validator\\Integer +------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/LengthBetween.rst b/docs/api/Validator/LengthBetween.rst index 5e2aef5..37bf570 100644 --- a/docs/api/Validator/LengthBetween.rst +++ b/docs/api/Validator/LengthBetween.rst @@ -1,6 +1,6 @@ ------------------------- -Validator\\LengthBetween ------------------------- +------------------------------- +Valdi\\Validator\\LengthBetween +------------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\LengthBetween .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Max.rst b/docs/api/Validator/Max.rst index d8f3e3b..83d515c 100644 --- a/docs/api/Validator/Max.rst +++ b/docs/api/Validator/Max.rst @@ -1,6 +1,6 @@ --------------- -Validator\\Max --------------- +--------------------- +Valdi\\Validator\\Max +--------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Max .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/MaxLength.rst b/docs/api/Validator/MaxLength.rst index e158658..0a802c1 100644 --- a/docs/api/Validator/MaxLength.rst +++ b/docs/api/Validator/MaxLength.rst @@ -1,6 +1,6 @@ --------------------- -Validator\\MaxLength --------------------- +--------------------------- +Valdi\\Validator\\MaxLength +--------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\MaxLength .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Min.rst b/docs/api/Validator/Min.rst index 20f500d..2cad13d 100644 --- a/docs/api/Validator/Min.rst +++ b/docs/api/Validator/Min.rst @@ -1,6 +1,6 @@ --------------- -Validator\\Min --------------- +--------------------- +Valdi\\Validator\\Min +--------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Min .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/MinLength.rst b/docs/api/Validator/MinLength.rst index b2a167c..aac46c0 100644 --- a/docs/api/Validator/MinLength.rst +++ b/docs/api/Validator/MinLength.rst @@ -1,6 +1,6 @@ --------------------- -Validator\\MinLength --------------------- +--------------------------- +Valdi\\Validator\\MinLength +--------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\MinLength .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/OlderThan.rst b/docs/api/Validator/OlderThan.rst index 1f6c1d1..5886b32 100644 --- a/docs/api/Validator/OlderThan.rst +++ b/docs/api/Validator/OlderThan.rst @@ -1,6 +1,6 @@ --------------------- -Validator\\OlderThan --------------------- +--------------------------- +Valdi\\Validator\\OlderThan +--------------------------- .. php:namespace: Valdi\\Validator @@ -52,7 +52,7 @@ Validator\\OlderThan Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -70,7 +70,7 @@ Validator\\OlderThan .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/OrCombine.rst b/docs/api/Validator/OrCombine.rst index 6947294..574e95c 100644 --- a/docs/api/Validator/OrCombine.rst +++ b/docs/api/Validator/OrCombine.rst @@ -1,5 +1,5 @@ --------------------------- -Validator\\OrCombine +Valdi\\Validator\\OrCombine --------------------------- .. php:namespace: Valdi\\Validator @@ -8,7 +8,7 @@ Validator\\OrCombine Validator to combine other validators with a logical "or". - .. php:attr:: invalid + .. php:attr:: invalidDetails protected @@ -16,7 +16,7 @@ Validator\\OrCombine .. php:method:: checkParameters($parameters) - Checks whether the given parameters fullfil: + Checks whether the given parameters fulfil: - At least three given - The first one is a Validator or a subclass of it diff --git a/docs/api/Validator/Regexp.rst b/docs/api/Validator/Regexp.rst index 715a420..167b43d 100644 --- a/docs/api/Validator/Regexp.rst +++ b/docs/api/Validator/Regexp.rst @@ -1,6 +1,6 @@ ------------------ -Validator\\Regexp ------------------ +------------------------ +Valdi\\Validator\\Regexp +------------------------ .. toctree:: @@ -52,7 +52,7 @@ Validator\\Regexp .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Required.rst b/docs/api/Validator/Required.rst index d59c9c9..68596f4 100644 --- a/docs/api/Validator/Required.rst +++ b/docs/api/Validator/Required.rst @@ -1,6 +1,6 @@ -------------------- -Validator\\Required -------------------- +-------------------------- +Valdi\\Validator\\Required +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/Slug.rst b/docs/api/Validator/Slug.rst index badeb5b..ad9bd14 100644 --- a/docs/api/Validator/Slug.rst +++ b/docs/api/Validator/Slug.rst @@ -1,6 +1,6 @@ ---------------- -Validator\\Slug ---------------- +---------------------- +Valdi\\Validator\\Slug +---------------------- .. php:namespace: Valdi\\Validator @@ -48,7 +48,7 @@ Validator\\Slug .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/Url.rst b/docs/api/Validator/Url.rst index bf2f450..2994c21 100644 --- a/docs/api/Validator/Url.rst +++ b/docs/api/Validator/Url.rst @@ -1,6 +1,6 @@ --------------- -Validator\\Url --------------- +--------------------- +Valdi\\Validator\\Url +--------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/ValidatorInterface.rst b/docs/api/Validator/ValidatorInterface.rst index 9a1b403..b905e2b 100644 --- a/docs/api/Validator/ValidatorInterface.rst +++ b/docs/api/Validator/ValidatorInterface.rst @@ -1,6 +1,6 @@ ------------------------------ -Validator\\ValidatorInterface ------------------------------ +------------------------------------ +Valdi\\Validator\\ValidatorInterface +------------------------------------ .. php:namespace: Valdi\\Validator diff --git a/docs/api/Validator/Value.rst b/docs/api/Validator/Value.rst index eeab997..a3c02b5 100644 --- a/docs/api/Validator/Value.rst +++ b/docs/api/Validator/Value.rst @@ -1,6 +1,6 @@ ----------------- -Validator\\Value ----------------- +----------------------- +Valdi\\Validator\\Value +----------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Value .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/Validator/YoungerThan.rst b/docs/api/Validator/YoungerThan.rst index 648b6dd..d6efcf6 100644 --- a/docs/api/Validator/YoungerThan.rst +++ b/docs/api/Validator/YoungerThan.rst @@ -1,6 +1,6 @@ ----------------------- -Validator\\YoungerThan ----------------------- +----------------------------- +Valdi\\Validator\\YoungerThan +----------------------------- .. php:namespace: Valdi\\Validator @@ -52,7 +52,7 @@ Validator\\YoungerThan Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -70,7 +70,7 @@ Validator\\YoungerThan .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/api/ValidatorException.rst b/docs/api/ValidatorException.rst index 99056d4..a4ed2bd 100644 --- a/docs/api/ValidatorException.rst +++ b/docs/api/ValidatorException.rst @@ -1,6 +1,6 @@ ------------------- -ValidatorException ------------------- +------------------------- +Valdi\\ValidatorException +------------------------- .. php:namespace: Valdi diff --git a/docs/html/0.10.0/_sources/api/RulesBuilder.txt b/docs/html/0.10.0/_sources/api/RulesBuilder.txt index 15d290b..fbb82e6 100644 --- a/docs/html/0.10.0/_sources/api/RulesBuilder.txt +++ b/docs/html/0.10.0/_sources/api/RulesBuilder.txt @@ -1,6 +1,6 @@ ------------- -RulesBuilder ------------- +------------------- +Valdi\\RulesBuilder +------------------- .. php:namespace: Valdi diff --git a/docs/html/0.10.0/_sources/api/ValidationException.txt b/docs/html/0.10.0/_sources/api/ValidationException.txt index 9aae73f..a49887d 100644 --- a/docs/html/0.10.0/_sources/api/ValidationException.txt +++ b/docs/html/0.10.0/_sources/api/ValidationException.txt @@ -1,6 +1,6 @@ -------------------- -ValidationException -------------------- +-------------------------- +Valdi\\ValidationException +-------------------------- .. php:namespace: Valdi diff --git a/docs/html/0.10.0/_sources/api/Validator.txt b/docs/html/0.10.0/_sources/api/Validator.txt index f7be304..f01c9d6 100644 --- a/docs/html/0.10.0/_sources/api/Validator.txt +++ b/docs/html/0.10.0/_sources/api/Validator.txt @@ -1,6 +1,6 @@ ---------- -Validator ---------- +---------------- +Valdi\\Validator +---------------- .. php:namespace: Valdi diff --git a/docs/html/0.10.0/_sources/api/Validator/AbstractComparator.txt b/docs/html/0.10.0/_sources/api/Validator/AbstractComparator.txt index e883d27..4ba1b14 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AbstractComparator.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AbstractComparator.txt @@ -1,6 +1,6 @@ ------------------------------ -Validator\\AbstractComparator ------------------------------ +------------------------------------ +Valdi\\Validator\\AbstractComparator +------------------------------------ .. toctree:: @@ -61,7 +61,7 @@ Validator\\AbstractComparator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/AbstractDateTimeComparator.txt b/docs/html/0.10.0/_sources/api/Validator/AbstractDateTimeComparator.txt index c350658..9811cbf 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AbstractDateTimeComparator.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AbstractDateTimeComparator.txt @@ -1,6 +1,6 @@ -------------------------------------- -Validator\\AbstractDateTimeComparator -------------------------------------- +-------------------------------------------- +Valdi\\Validator\\AbstractDateTimeComparator +-------------------------------------------- .. toctree:: @@ -64,7 +64,7 @@ Validator\\AbstractDateTimeComparator Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -82,7 +82,7 @@ Validator\\AbstractDateTimeComparator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/AbstractFilter.txt b/docs/html/0.10.0/_sources/api/Validator/AbstractFilter.txt index 20757a9..8ca6962 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AbstractFilter.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AbstractFilter.txt @@ -1,6 +1,6 @@ -------------------------- -Validator\\AbstractFilter -------------------------- +-------------------------------- +Valdi\\Validator\\AbstractFilter +-------------------------------- .. toctree:: @@ -38,3 +38,9 @@ Validator\\AbstractFilter :param $value: :param $parameters: + + .. php:method:: getInvalidDetails() + + Gets the details if the validation failed. + + :returns: mixed the details diff --git a/docs/html/0.10.0/_sources/api/Validator/AbstractParametrizedValidator.txt b/docs/html/0.10.0/_sources/api/Validator/AbstractParametrizedValidator.txt index e2ba2b5..49f465e 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AbstractParametrizedValidator.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AbstractParametrizedValidator.txt @@ -1,6 +1,6 @@ ----------------------------------------- -Validator\\AbstractParametrizedValidator ----------------------------------------- +----------------------------------------------- +Valdi\\Validator\\AbstractParametrizedValidator +----------------------------------------------- .. toctree:: @@ -15,7 +15,7 @@ Validator\\AbstractParametrizedValidator .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string @@ -34,3 +34,9 @@ Validator\\AbstractParametrizedValidator :type $parameters: array :param $parameters: the other parameters the validator might need :returns: boolean true if the value is valid, false else + + .. php:method:: getInvalidDetails() + + Gets the details if the validation failed. + + :returns: mixed the details diff --git a/docs/html/0.10.0/_sources/api/Validator/AfterDateTime.txt b/docs/html/0.10.0/_sources/api/Validator/AfterDateTime.txt index d43fef2..008d857 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AfterDateTime.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AfterDateTime.txt @@ -1,6 +1,6 @@ ------------------------- -Validator\\AfterDateTime ------------------------- +------------------------------- +Valdi\\Validator\\AfterDateTime +------------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\AfterDateTime Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\AfterDateTime .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/AlphaNumerical.txt b/docs/html/0.10.0/_sources/api/Validator/AlphaNumerical.txt index d997a54..5a67abd 100644 --- a/docs/html/0.10.0/_sources/api/Validator/AlphaNumerical.txt +++ b/docs/html/0.10.0/_sources/api/Validator/AlphaNumerical.txt @@ -1,6 +1,6 @@ -------------------------- -Validator\\AlphaNumerical -------------------------- +-------------------------------- +Valdi\\Validator\\AlphaNumerical +-------------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\AlphaNumerical .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Alphabetical.txt b/docs/html/0.10.0/_sources/api/Validator/Alphabetical.txt index 162a719..a2b7568 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Alphabetical.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Alphabetical.txt @@ -1,6 +1,6 @@ ------------------------ -Validator\\Alphabetical ------------------------ +------------------------------ +Valdi\\Validator\\Alphabetical +------------------------------ .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Alphabetical .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/BeforeDateTime.txt b/docs/html/0.10.0/_sources/api/Validator/BeforeDateTime.txt index ac35bc7..a2216c3 100644 --- a/docs/html/0.10.0/_sources/api/Validator/BeforeDateTime.txt +++ b/docs/html/0.10.0/_sources/api/Validator/BeforeDateTime.txt @@ -1,6 +1,6 @@ -------------------------- -Validator\\BeforeDateTime -------------------------- +-------------------------------- +Valdi\\Validator\\BeforeDateTime +-------------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\BeforeDateTime Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\BeforeDateTime .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Between.txt b/docs/html/0.10.0/_sources/api/Validator/Between.txt index 05dde49..2ccbe34 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Between.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Between.txt @@ -1,6 +1,6 @@ ------------------- -Validator\\Between ------------------- +------------------------- +Valdi\\Validator\\Between +------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Between .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Boolean.txt b/docs/html/0.10.0/_sources/api/Validator/Boolean.txt index f38c60a..4d1980d 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Boolean.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Boolean.txt @@ -1,6 +1,6 @@ ------------------- -Validator\\Boolean ------------------- +------------------------- +Valdi\\Validator\\Boolean +------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/Contains.txt b/docs/html/0.10.0/_sources/api/Validator/Contains.txt index c1a6999..6f21a25 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Contains.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Contains.txt @@ -1,6 +1,6 @@ -------------------- -Validator\\Contains -------------------- +-------------------------- +Valdi\\Validator\\Contains +-------------------------- .. php:namespace: Valdi\\Validator @@ -10,7 +10,7 @@ Validator\\Contains .. php:method:: validateParameterCount($parameterAmount) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $parameterAmount: integer diff --git a/docs/html/0.10.0/_sources/api/Validator/DateTime.txt b/docs/html/0.10.0/_sources/api/Validator/DateTime.txt index d93c916..9cc8bec 100644 --- a/docs/html/0.10.0/_sources/api/Validator/DateTime.txt +++ b/docs/html/0.10.0/_sources/api/Validator/DateTime.txt @@ -1,6 +1,6 @@ -------------------- -Validator\\DateTime -------------------- +-------------------------- +Valdi\\Validator\\DateTime +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/DateTimeBetween.txt b/docs/html/0.10.0/_sources/api/Validator/DateTimeBetween.txt index 49b3e5a..eff1a54 100644 --- a/docs/html/0.10.0/_sources/api/Validator/DateTimeBetween.txt +++ b/docs/html/0.10.0/_sources/api/Validator/DateTimeBetween.txt @@ -51,7 +51,7 @@ Valdi\\Validator\\DateTimeBetween Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Valdi\\Validator\\DateTimeBetween .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Email.txt b/docs/html/0.10.0/_sources/api/Validator/Email.txt index f495d8a..7d4c49b 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Email.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Email.txt @@ -1,6 +1,6 @@ ----------------- -Validator\\Email ----------------- +----------------------- +Valdi\\Validator\\Email +----------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/Floating.txt b/docs/html/0.10.0/_sources/api/Validator/Floating.txt index bc59ca4..0bf06c7 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Floating.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Floating.txt @@ -1,6 +1,6 @@ -------------------- -Validator\\Floating -------------------- +-------------------------- +Valdi\\Validator\\Floating +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/IP.txt b/docs/html/0.10.0/_sources/api/Validator/IP.txt index 91a0852..d23a1b9 100644 --- a/docs/html/0.10.0/_sources/api/Validator/IP.txt +++ b/docs/html/0.10.0/_sources/api/Validator/IP.txt @@ -1,6 +1,6 @@ -------------- -Validator\\IP -------------- +-------------------- +Valdi\\Validator\\IP +-------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/IPv4.txt b/docs/html/0.10.0/_sources/api/Validator/IPv4.txt index 30e81a1..f5b46d8 100644 --- a/docs/html/0.10.0/_sources/api/Validator/IPv4.txt +++ b/docs/html/0.10.0/_sources/api/Validator/IPv4.txt @@ -1,6 +1,6 @@ ---------------- -Validator\\IPv4 ---------------- +---------------------- +Valdi\\Validator\\IPv4 +---------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/IPv6.txt b/docs/html/0.10.0/_sources/api/Validator/IPv6.txt index 0fe4d63..9a56ffb 100644 --- a/docs/html/0.10.0/_sources/api/Validator/IPv6.txt +++ b/docs/html/0.10.0/_sources/api/Validator/IPv6.txt @@ -1,6 +1,6 @@ ---------------- -Validator\\IPv6 ---------------- +---------------------- +Valdi\\Validator\\IPv6 +---------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/InSet.txt b/docs/html/0.10.0/_sources/api/Validator/InSet.txt index 0c824bc..3222882 100644 --- a/docs/html/0.10.0/_sources/api/Validator/InSet.txt +++ b/docs/html/0.10.0/_sources/api/Validator/InSet.txt @@ -1,6 +1,6 @@ ----------------- -Validator\\InSet ----------------- +----------------------- +Valdi\\Validator\\InSet +----------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/InTheFuture.txt b/docs/html/0.10.0/_sources/api/Validator/InTheFuture.txt index 26998c9..28b54a0 100644 --- a/docs/html/0.10.0/_sources/api/Validator/InTheFuture.txt +++ b/docs/html/0.10.0/_sources/api/Validator/InTheFuture.txt @@ -1,6 +1,6 @@ ----------------------- -Validator\\InTheFuture ----------------------- +----------------------------- +Valdi\\Validator\\InTheFuture +----------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\InTheFuture Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\InTheFuture .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/InThePast.txt b/docs/html/0.10.0/_sources/api/Validator/InThePast.txt index 938e2a9..759f779 100644 --- a/docs/html/0.10.0/_sources/api/Validator/InThePast.txt +++ b/docs/html/0.10.0/_sources/api/Validator/InThePast.txt @@ -1,6 +1,6 @@ --------------------- -Validator\\InThePast --------------------- +--------------------------- +Valdi\\Validator\\InThePast +--------------------------- .. php:namespace: Valdi\\Validator @@ -51,7 +51,7 @@ Validator\\InThePast Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -69,7 +69,7 @@ Validator\\InThePast .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Integer.txt b/docs/html/0.10.0/_sources/api/Validator/Integer.txt index aae3cf0..02f4fe8 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Integer.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Integer.txt @@ -1,6 +1,6 @@ ------------------- -Validator\\Integer ------------------- +------------------------- +Valdi\\Validator\\Integer +------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/LengthBetween.txt b/docs/html/0.10.0/_sources/api/Validator/LengthBetween.txt index 5e2aef5..37bf570 100644 --- a/docs/html/0.10.0/_sources/api/Validator/LengthBetween.txt +++ b/docs/html/0.10.0/_sources/api/Validator/LengthBetween.txt @@ -1,6 +1,6 @@ ------------------------- -Validator\\LengthBetween ------------------------- +------------------------------- +Valdi\\Validator\\LengthBetween +------------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\LengthBetween .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Max.txt b/docs/html/0.10.0/_sources/api/Validator/Max.txt index d8f3e3b..83d515c 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Max.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Max.txt @@ -1,6 +1,6 @@ --------------- -Validator\\Max --------------- +--------------------- +Valdi\\Validator\\Max +--------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Max .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/MaxLength.txt b/docs/html/0.10.0/_sources/api/Validator/MaxLength.txt index e158658..0a802c1 100644 --- a/docs/html/0.10.0/_sources/api/Validator/MaxLength.txt +++ b/docs/html/0.10.0/_sources/api/Validator/MaxLength.txt @@ -1,6 +1,6 @@ --------------------- -Validator\\MaxLength --------------------- +--------------------------- +Valdi\\Validator\\MaxLength +--------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\MaxLength .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Min.txt b/docs/html/0.10.0/_sources/api/Validator/Min.txt index 20f500d..2cad13d 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Min.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Min.txt @@ -1,6 +1,6 @@ --------------- -Validator\\Min --------------- +--------------------- +Valdi\\Validator\\Min +--------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Min .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/MinLength.txt b/docs/html/0.10.0/_sources/api/Validator/MinLength.txt index b2a167c..aac46c0 100644 --- a/docs/html/0.10.0/_sources/api/Validator/MinLength.txt +++ b/docs/html/0.10.0/_sources/api/Validator/MinLength.txt @@ -1,6 +1,6 @@ --------------------- -Validator\\MinLength --------------------- +--------------------------- +Valdi\\Validator\\MinLength +--------------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\MinLength .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/OlderThan.txt b/docs/html/0.10.0/_sources/api/Validator/OlderThan.txt index 1f6c1d1..5886b32 100644 --- a/docs/html/0.10.0/_sources/api/Validator/OlderThan.txt +++ b/docs/html/0.10.0/_sources/api/Validator/OlderThan.txt @@ -1,6 +1,6 @@ --------------------- -Validator\\OlderThan --------------------- +--------------------------- +Valdi\\Validator\\OlderThan +--------------------------- .. php:namespace: Valdi\\Validator @@ -52,7 +52,7 @@ Validator\\OlderThan Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -70,7 +70,7 @@ Validator\\OlderThan .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/OrCombine.txt b/docs/html/0.10.0/_sources/api/Validator/OrCombine.txt index 6947294..574e95c 100644 --- a/docs/html/0.10.0/_sources/api/Validator/OrCombine.txt +++ b/docs/html/0.10.0/_sources/api/Validator/OrCombine.txt @@ -1,5 +1,5 @@ --------------------------- -Validator\\OrCombine +Valdi\\Validator\\OrCombine --------------------------- .. php:namespace: Valdi\\Validator @@ -8,7 +8,7 @@ Validator\\OrCombine Validator to combine other validators with a logical "or". - .. php:attr:: invalid + .. php:attr:: invalidDetails protected @@ -16,7 +16,7 @@ Validator\\OrCombine .. php:method:: checkParameters($parameters) - Checks whether the given parameters fullfil: + Checks whether the given parameters fulfil: - At least three given - The first one is a Validator or a subclass of it diff --git a/docs/html/0.10.0/_sources/api/Validator/Regexp.txt b/docs/html/0.10.0/_sources/api/Validator/Regexp.txt index 715a420..167b43d 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Regexp.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Regexp.txt @@ -1,6 +1,6 @@ ------------------ -Validator\\Regexp ------------------ +------------------------ +Valdi\\Validator\\Regexp +------------------------ .. toctree:: @@ -52,7 +52,7 @@ Validator\\Regexp .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Required.txt b/docs/html/0.10.0/_sources/api/Validator/Required.txt index d59c9c9..68596f4 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Required.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Required.txt @@ -1,6 +1,6 @@ -------------------- -Validator\\Required -------------------- +-------------------------- +Valdi\\Validator\\Required +-------------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/Slug.txt b/docs/html/0.10.0/_sources/api/Validator/Slug.txt index badeb5b..ad9bd14 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Slug.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Slug.txt @@ -1,6 +1,6 @@ ---------------- -Validator\\Slug ---------------- +---------------------- +Valdi\\Validator\\Slug +---------------------- .. php:namespace: Valdi\\Validator @@ -48,7 +48,7 @@ Validator\\Slug .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/Url.txt b/docs/html/0.10.0/_sources/api/Validator/Url.txt index bf2f450..2994c21 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Url.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Url.txt @@ -1,6 +1,6 @@ --------------- -Validator\\Url --------------- +--------------------- +Valdi\\Validator\\Url +--------------------- .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/ValidatorInterface.txt b/docs/html/0.10.0/_sources/api/Validator/ValidatorInterface.txt index 9a1b403..b905e2b 100644 --- a/docs/html/0.10.0/_sources/api/Validator/ValidatorInterface.txt +++ b/docs/html/0.10.0/_sources/api/Validator/ValidatorInterface.txt @@ -1,6 +1,6 @@ ------------------------------ -Validator\\ValidatorInterface ------------------------------ +------------------------------------ +Valdi\\Validator\\ValidatorInterface +------------------------------------ .. php:namespace: Valdi\\Validator diff --git a/docs/html/0.10.0/_sources/api/Validator/Value.txt b/docs/html/0.10.0/_sources/api/Validator/Value.txt index eeab997..a3c02b5 100644 --- a/docs/html/0.10.0/_sources/api/Validator/Value.txt +++ b/docs/html/0.10.0/_sources/api/Validator/Value.txt @@ -1,6 +1,6 @@ ----------------- -Validator\\Value ----------------- +----------------------- +Valdi\\Validator\\Value +----------------------- .. php:namespace: Valdi\\Validator @@ -46,7 +46,7 @@ Validator\\Value .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/Validator/YoungerThan.txt b/docs/html/0.10.0/_sources/api/Validator/YoungerThan.txt index 648b6dd..d6efcf6 100644 --- a/docs/html/0.10.0/_sources/api/Validator/YoungerThan.txt +++ b/docs/html/0.10.0/_sources/api/Validator/YoungerThan.txt @@ -1,6 +1,6 @@ ----------------------- -Validator\\YoungerThan ----------------------- +----------------------------- +Valdi\\Validator\\YoungerThan +----------------------------- .. php:namespace: Valdi\\Validator @@ -52,7 +52,7 @@ Validator\\YoungerThan Interprets the given parameters as date times and returns them. :type $parameters: array - :param $parameters: the paramters + :param $parameters: the parameters :type $format: string :param $format: the date time format :returns: \DateTime[] the date times @@ -70,7 +70,7 @@ Validator\\YoungerThan .. php:method:: validateParameterCount($name, $parameterAmount, $parameters) - Throws an exception if the parameters don't fullfill the expected + Throws an exception if the parameters don't fulfill the expected parameter count. :type $name: string diff --git a/docs/html/0.10.0/_sources/api/ValidatorException.txt b/docs/html/0.10.0/_sources/api/ValidatorException.txt index 99056d4..a4ed2bd 100644 --- a/docs/html/0.10.0/_sources/api/ValidatorException.txt +++ b/docs/html/0.10.0/_sources/api/ValidatorException.txt @@ -1,6 +1,6 @@ ------------------- -ValidatorException ------------------- +------------------------- +Valdi\\ValidatorException +------------------------- .. php:namespace: Valdi diff --git a/docs/html/0.10.0/_sources/manual/validators.txt b/docs/html/0.10.0/_sources/manual/validators.txt index 5cba2af..4a29bcd 100644 --- a/docs/html/0.10.0/_sources/manual/validators.txt +++ b/docs/html/0.10.0/_sources/manual/validators.txt @@ -117,7 +117,7 @@ Validates if the parameter is within the given value. **Parameters** * sub value: the value which must be within the value to validate -* case sensitive: boolean value indicating whether the comparsion should be +* case sensitive: boolean value indicating whether the comparision should be case sensitive; optional, defaults to true ^^^^^ @@ -152,7 +152,7 @@ the given parameters. **Parameters** -* min length: The mininum string length +* min length: The minimum string length * max length: The maximum string length ^^^^^^^^^ diff --git a/docs/html/0.10.0/api/RulesBuilder.html b/docs/html/0.10.0/api/RulesBuilder.html index a60960e..eff2c1a 100644 --- a/docs/html/0.10.0/api/RulesBuilder.html +++ b/docs/html/0.10.0/api/RulesBuilder.html @@ -8,7 +8,7 @@ - RulesBuilder — Valdi 0.9.0 documentation + Valdi\RulesBuilder — Valdi 0.9.0 documentation @@ -31,7 +31,7 @@ - + @@ -89,22 +89,18 @@

API

@@ -135,7 +131,7 @@

API

@@ -135,7 +131,7 @@

API

@@ -135,7 +131,7 @@

API