josantonius/validate

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP simple library for managing of data types.

1.0.1 2022-08-18 17:48 UTC

Requires

• php: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.3 || ^2.8
• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^5.7 || ^6.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Josantonius

• json
• email
• url
• array
• object
• string
• IP
• integer
• boolean
• float
• data type

README

Versión en español

PHP simple library for managing of data types.

• Requirements
• Installation
• Available Methods
• Quick Start
• Usage
• Tests
• Sponsor
• License

Requirements

This library is supported by PHP 7.4 version.

Installation

The preferred way to install this extension is through Composer.

To install PHP Validate library, simply:

composer require Josantonius/Validate

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require Josantonius/Validate --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-Validate.git

Or install it manually:

Download Validate.php:

wget https://raw.githubusercontent.com/Josantonius/PHP-Validate/master/src/Validate.php

Available Methods

Available methods in this library:

- Parameter return as array

Validate::asArray($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as object

Validate::asObject($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as JSON

Validate::asJson($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as string

Validate::asString($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as integer

Validate::asInteger($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as float

Validate::asFloat($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as boolean

Validate::asBoolean($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as IP

Validate::asIp($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as URL

Validate::asUrl($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

- Parameter return as URL

Validate::asEmail($data, $default);

Attribute	Description	Type	Required	Default
$data	Data to convert.	mixed	Yes
$default	Default value in error case.	mixed	No	´null´

# Return (mixed|null) → value, null or customized return value

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Validate\Validate;

Or if you installed it manually, use it:

require_once __DIR__ . '/Validate.php';

use Josantonius\Validate\Validate;

Usage

Example of use for this library:

- ARRAY

- When an array is passed

var_dump(Validate::asArray(['foo', 'bar'])); // ['foo', 'bar']

- When an JSON array is passed

var_dump(Validate::asArray('["foo", "bar"]')); // ['foo', 'bar']

- When an object is passed

$data = new \StdClass;

$data->foo = 'bar';

var_dump(Validate::asArray($data)); // ['foo' => 'bar']

- When an JSON object is passed

var_dump(Validate::asArray('{"foo": "bar"}')); // ['foo' => 'bar']

- Parameter return default value when there's no a correct array

var_dump(Validate::asArray(false)); // null

var_dump(Validate::asArray(false, ['foo', 'bar'])); // ['foo', 'bar']

- OBJECT

- When an object is passed

$data = new \StdClass;

$data->foo = 'bar';

$object = Validate::asObject($data);

echo $object->foo; // 'bar'

- When an JSON object is passed

$object = Validate::asObject('{"foo": "bar"}');

echo $object->foo; // 'bar'

- When an array is passed

$object = Validate::asObject(['foo' => 'bar']));

echo $object->foo; // 'bar'

- Parameter return default value when there's no a correct object

var_dump(Validate::asObject(false)); // null

$object = Validate::asObject(false, ['foo' => 'bar']);

echo $object->foo; // 'bar'

- JSON

- When an JSON object is passed

echo Validate::asJson('{"foo": "bar"}'); // '{"foo": "bar"}'

- When an array is passed

echo Validate::asJson(['foo' => 'bar']); // '{"foo":"bar"}'

- When an object is passed

$data = new \StdClass;

$data->foo = 'bar';

echo Validate::asJson($data); // '{"foo":"bar"}'

- Parameter return default value when there's no a correct JSON

var_dump(Validate::asJson(false)); // null

echo Validate::asJson(false, '["foo", "bar"]'); // '["foo", "bar"]'

- STRING

- When an string is passed

echo Validate::asString('foo'); // 'foo'

- When an integer is passed

echo Validate::asString(221104); // '221104'

- Parameter return default value when there's no a correct string

var_dump(Validate::asString(false)); // null

echo Validate::asString(false, 'foo'); // 'foo'

- INTEGER

- When an integer is passed

echo Validate::asInteger(8); // 8

- When an string is passed

echo Validate::asInteger('8'); // 8

- Parameter return default value when there's no a correct integer

var_dump(Validate::asInteger(false)); // null

echo Validate::asInteger(false, 8); // 8

- FLOAT

- When an float is passed

echo Validate::asFloat(8.8); // 8.8

- When an string is passed

echo Validate::asFloat('8.8'); // 8.8

- Parameter return default value when there's no a correct float

var_dump(Validate::asFloat(false)); // null

echo Validate::asFloat(false, 8.8); // 8.8

- BOOLEAN

- When an boolean true is passed

var_dump(Validate::asBoolean(true)); // true

- When an string true is passed

var_dump(Validate::asBoolean('true')); // true

- When an integer one is passed

var_dump(Validate::asBoolean(1)); // true

- When an string one is passed

var_dump(Validate::asBoolean('1')); // true

- When an boolean false is passed

var_dump(Validate::asBoolean(false)); // false

- When an string false is passed

var_dump(Validate::asBoolean('false')); // false

- When an integer zero is passed

var_dump(Validate::asBoolean(0)); // false

- When an string zero is passed

var_dump(Validate::asBoolean('0')); // false

- Parameter return default value when there's no a correct boolean

var_dump(Validate::asBoolean(null)); // null

echo Validate::asBoolean(null, true); // true

- IP

- When an IP is passed

echo Validate::asIp('255.255.255.0'); // '255.255.255.0'

- Parameter return default value when there's no a correct IP

var_dump(Validate::asIp(null)); // null

echo Validate::asIp(null, '255.255.255.0'); // '255.255.255.0'

- URL

- When an URL is passed

echo Validate::asUrl('https://josantonius.com'); // 'https://josantonius.com'

- Parameter return default value when there's no a correct URL

var_dump(Validate::asUrl(null)); // null

echo Validate::asUrl(null, 'https://josantonius.com'); // 'https://josantonius.com'

- Email

- When an email is passed

echo Validate::asEmail('[e-mail]'); // '[e-mail]'

- Parameter return default value when there's no a correct email

var_dump(Validate::asEmail(null)); // null

echo Validate::asEmail(null, '[e-mail]'); // '[e-mail]'

Tests

To run tests you just need composer and to execute the following:

git clone https://github.com/Josantonius/PHP-Validate.git

cd PHP-Validate

composer install

Run unit tests with PHPUnit:

composer phpunit

Run PSR2 code standard tests with PHPCS:

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

composer phpmd

Run all previous tests:

composer tests

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊

License

This repository is licensed under the MIT License.

Copyright © 2018-2022, Josantonius