PHP download

Download the PHP package messere/php-value-mask without Composer

On this page you can find all versions of the php package messere/php-value-mask. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download messere/php-value-mask
More information about messere/php-value-mask
Files in messere/php-value-mask

Vendor messere
Package php-value-mask
Short Description extract subset of array / object values
License MIT
Homepage https://github.com/Messere/php-value-mask

Keywords filter filtering mask partial response array filtering json filtering

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of messere/php-value-mask

Informations about the package php-value-mask

php-value-mask

Purpose

Google in their Performance Tips for APIs, suggest to limit required bandwidth by filtering out unused fields in response. Their APIs support additional URL parameter fields which asks API to include only specific fields in response.

fields parameter follows a simple syntax, which allows to query for nested keys, multiple keys or use wildcard to include all fields (see Syntax and Grammar sections below).

This library implements parsing of fields parameter and filtering of arrays / objects.

See also: PSR-15 compatible middleware based on this library: Partial Response PSR-15 Middleware

Usage example

Let's analyze elements of used filter:

title matches top level element with key title ('Good Omens')
identifiers/isbn matches top level element identifiers and then includes isbn element from matched object ('ISBN 83-85100-63-6')
authors/firstName finds an array of elements (list) under the key authors and examines all elements, extracting firstName from each. ('Terry' and 'Neil')
*(us,uk) examines all properties and extracts fields us and uk. ('1990' and '1990' from year element, 'Workman', 'Gollancz' from publisher)
keywords does not match anything and is silently ignored.

As a result we expect the following output:

ready to serialize to JSON, etc.

Note that library does preserve the structure/nesting of values, but not necessarily types of values - all objects are converted to associative arrays with object's public properties as keys.

Syntax

a selects key a from input
a,b,c comma separated list of elements: selects keys a and b and c
a/b/c nested elements: selects key c from parent element b which in turn has parent element a
a(b,c) multiple elements: selects elements b and c from parent element a
a(b,c/d) multiple elements: from parent a select element b and element d nested in c
a/*/c wildcard: selects element c from all children of element a
*(b,c) wildcard: selects elements b and c from any parent

Etc. See tests for more examples as well as examples of invalid filters.

Grammar

Since Google does not provide detailed grammar for their "fields" language, this package uses the following arbitrarily selected rules, that in author's opinion closely resamble intent of original authors.

In EBNF notation:

Acknowledgements

Library is inspired by:

Google's API performance tips.
Similar JavaScript library: nemtsov/json-mask.

License

MIT

All versions of php-value-mask with dependencies

PHP Build Version

Package Version

Version 0.1.2 Release 11. Feb 2021
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of php-value-mask from vendor messere

Requires php Version ^7.1 || ^8.0
ext-json Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package messere/php-value-mask contains the following files

Loading the files please wait ...