PHPackages                             mymedia/php-argument-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mymedia/php-argument-builder

ActiveLibrary[Utility & Helpers](/categories/utility)

mymedia/php-argument-builder
============================

Abstract argument builder library

1.1.0(7y ago)0914MITPHPPHP ^7.2

Since Jan 22Pushed 7y ago4 watchersCompare

[ Source](https://github.com/MyMedia/php-argument-builder)[ Packagist](https://packagist.org/packages/mymedia/php-argument-builder)[ RSS](/packages/mymedia-php-argument-builder/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependencies (1)Versions (3)Used By (0)

[Master](https://travis-ci.org/MyMedia/php-argument-builder)[![Build Status](https://camo.githubusercontent.com/6da3973aa7382b6104e5fc02927b853cdd7c94ffec6885f7cf4a6d926293ec8e/68747470733a2f2f7472617669732d63692e6f72672f4d794d656469612f7068702d617267756d656e742d6275696c6465722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/MyMedia/php-argument-builder)[![Coverage Status](https://camo.githubusercontent.com/d5a44cccd4a8d307ae0596035f8c6dd37545f4587bb990b95efa31e1d5a07cf7/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4d794d656469612f7068702d617267756d656e742d6275696c6465722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/MyMedia/php-argument-builder/?branch=master)[![Quality Status](https://camo.githubusercontent.com/659f89a66d39a6c704f00baeeb497418cb1c097d2bc006a1f16a0647516e2612/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4d794d656469612f7068702d617267756d656e742d6275696c6465722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/MyMedia/php-argument-builder/?branch=master)Argument Builder Library
========================

[](#argument-builder-library)

AbstractArgumentBuilder class is used to build a query string from pre-defined validatable parameters. It can also be used to the reverse so that the application uses only the desired validated parameters. Generates its own property getters and setters and unset via automated magic function.

Installation
============

[](#installation)

First, install the dependency:

```
$ composer require mymedia/php-argument-builder
```

Usage examples
==============

[](#usage-examples)

Basic usage
-----------

[](#basic-usage)

### AbstractArgumentBuilder

[](#abstractargumentbuilder)

AbstractArgumentBuilder implements ArgumentBuilderInterface which provides only one method: build(). Magic function \_\_call() provides access to getters and setters, and unset, without the need to generate them manually. It also provides us with \_\_toString() function that returns http query string.

```
$builder
    ->setSearch('foobar')
    ->setFilter('color', 'iridescent')
    ->setFilter('size', 'height', 2)
    ->setFilter('size', 'width', 10);
```

Using the provided functionality, the presented code will generate query arguments like: `http://example.com/?search=foobar&filter[color]=iridescent&filter[size][height]=2&filter[size][width]=10.` However this requires additional classes to extend the `AbstractArgumentBuilder` that we will define in the next section.

### Extending AbstractArgumentBuilder

[](#extending-abstractargumentbuilder)

#### Argument Types

[](#argument-types)

`AbstractArgumentBuilder` defines following constants, that are used in field validation:

```
    const ARGUMENT_TYPE_MIXED = 0;
    const ARGUMENT_TYPE_ARGUMENT_BUILDER = 1;
    const ARGUMENT_TYPE_NUMERIC = 2;
    const ARGUMENT_TYPE_ENUM = 3;
    const ARGUMENT_TYPE_BOOLEAN = 4;
```

#### Classes

[](#classes)

```
class SearchArgumentBuilder extends AbstractArgumentBuilder
{
    protected $fields = [
        'search' => self::ARGUMENT_TYPE_MIXED,
        'filter' => SearchFilterArgumentBuilder::class,
    ];
}
```

```
class SearchFilterArgumentBuilder extends AbstractArgumentBuilder
{
    protected $fields = [
        'color' => self::ARGUMENT_TYPE_MIXED,
        'size' => SearchFilterSizeArgumentConverter::class,
    ];
}
```

```
class SearchFilterSizeArgumentBuilder extends AbstractArgumentBuilder
{
    protected $fields = [
        'height' => self::ARGUMENT_TYPE_MIXED,
        'width' => self::ARGUMENT_TYPE_MIXED,
    ];
}
```

### Field Validation

[](#field-validation)

A simple way to provide field validation, it will fail if the defined condition is not met:

```
class SearchFilterPriceArgumentBuilder extends AbstractArgumentBuilder
{
    protected function load()
    {
        $this->fields = array(
            'min' => array(
                'type' => self::ARGUMENT_TYPE_MIXED,
                'validator' => function ($value) {
                    return $value >= 0 && $value  array(
                'type' => self::ARGUMENT_TYPE_MIXED,
                'validator' => function ($value) {
                    return $value >= 0 && $value