some phpdoc improvements.

This commit is contained in:
Marcel Naeve 2016-05-13 19:51:06 +02:00
parent 89ed39c79d
commit d178d8beab
2 changed files with 23 additions and 16 deletions

View File

@ -1,4 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="Behat">
<behat_settings>
<BehatSettings behat_path="$PROJECT_DIR$" />
</behat_settings>
</component>
<component name="PhpProjectSharedConfiguration" php_language_level="7" /> <component name="PhpProjectSharedConfiguration" php_language_level="7" />
<component name="PhpUnit">
<phpunit_settings>
<PhpUnitSettings />
</phpunit_settings>
</component>
</project> </project>

View File

@ -1,18 +1,14 @@
<?php <?php
/** /**
* User: Marcel 'CoNfu5eD Naeve <confu5ed@serious-pro.de> * Utility Class for validating data.
* Date: 03.05.2016 * @license https://github.com/CoNfu5eD/php7-validation-class/blob/master/LICENSE MIT
* Time: 21:28 * @author CoNfu5eD (Marcel Naeve) <confu5ed@serious-pro.de>
*/
/**
* Class Validate.
*/ */
class Validate class Validate
{ {
/** /**
* Static function for validating email addresses with multiple secure levels and black- and whitelist. * Static method for validating email addresses with multiple secure levels and black- and whitelist.
* @param string $email email address * @param string $email email address
* @param int $level secure level * @param int $level secure level
* @param array $lists filter lists like whitelist, blacklist,.. * @param array $lists filter lists like whitelist, blacklist,..
@ -55,7 +51,7 @@ class Validate
} }
/** /**
* Static function for validating a IP Address. * Static method for validating a IP Address.
* @param string $address IP address * @param string $address IP address
* @return bool is the IP Address valid? * @return bool is the IP Address valid?
*/ */
@ -65,7 +61,7 @@ class Validate
} }
/** /**
* Static function for validating a IPv4 Address. * Static method for validating a IPv4 Address.
* @param string $address IPv4 address * @param string $address IPv4 address
* @return bool is the IPv4 Address valid? * @return bool is the IPv4 Address valid?
*/ */
@ -75,7 +71,7 @@ class Validate
} }
/** /**
* Static function for validating a IPv6 Address. * Static method for validating a IPv6 Address.
* @param string $address IPv6 address * @param string $address IPv6 address
* @return bool is the IPv6 Address valid? * @return bool is the IPv6 Address valid?
*/ */
@ -85,7 +81,7 @@ class Validate
} }
/** /**
* Static function for validation a Mac Address. * Static method for validation a Mac Address.
* @param string $address mac address * @param string $address mac address
* @return bool is the mac valid? * @return bool is the mac valid?
*/ */
@ -95,7 +91,7 @@ class Validate
} }
/** /**
* Static function for validating URLs. * Static method for validating URLs.
* @param string $url URL * @param string $url URL
* @return bool is the URL valid? * @return bool is the URL valid?
*/ */
@ -105,7 +101,7 @@ class Validate
} }
/** /**
* Static function for validating a number range. * Static method for validating a number range.
* @param float $value number to validate * @param float $value number to validate
* @param float $min min value * @param float $min min value
* @param float $max max value * @param float $max max value
@ -117,7 +113,8 @@ class Validate
} }
/** /**
* Static function for validating a IBAN (International Bank Account Number). * Static method for validating a IBAN (International Bank Account Number).
* @link https://www.swift.com/sites/default/files/resources/swift_standards_ibanregistry.pdf IBAN Standards (Swift)
* @param string $iban International Bank Account Number * @param string $iban International Bank Account Number
* @return bool is the IBAN valid? * @return bool is the IBAN valid?
*/ */
@ -168,7 +165,7 @@ class Validate
} }
/** /**
* A static method to validate SWIFT/BIC codes. * Static method to validate SWIFT/BIC codes.
* @param string $swift swift/bic code * @param string $swift swift/bic code
* @return bool swift/bic valid? * @return bool swift/bic valid?
*/ */