Giter VIP home page Giter VIP logo

php-arguments's Introduction

PHP-Arguments

Code Climate Test Coverage Issue Count

Formerly monochromist/php-arguments

PHP-Arguments is an utility class for arguments validation code. Nothing special here, just some utility methods for libraries that need to enforce arguments validation and provide better error messages to developers using a library.

Example

use robotdance/Arguments;
...
public function doSomething($arg1, $arg2, $arg3, $arg4) {
  // string or boolean required
  Arguments::validate($arg1, ['string', 'boolean'];
  // integer required
  Arguments::validate($arg2, ['integer']);
  // not null required
  Arguments::notNull($arg3);
  // check if $arg4 is a string=>any associative array
  Arguments::validateAssociativeArray($arg4);
}

Setup

PHP-Arguments uses Composer as dependency manager.

$ composer install

You may also generate documentation:

$ ./bin/phpdoc -d ./src/ -t ./docs/

Testing

$ ./bin/phpunit

Contribute

Simply fork, code your tests and modifications, write a good commit message and submit a pull request. All tests must pass and the coverage must remains at 100%.

References

PHP the right way

php-arguments's People

Contributors

marcosmenegazzo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.