Download the PHP package fabianofa/jsonboperators-bundle without Composer
On this page you can find all versions of the php package fabianofa/jsonboperators-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package jsonboperators-bundle
JsonbOperatorsBundle
PostgreSQL 9.4 introduced the new data type jsonb. With it some documented operators such as ->, ->> and #>>{} are available to access or retrieve values within a jsonb column data. Since Symfony uses Doctrine as default and Doctrine uses its own query language DQL, the operators aren't available natively. You can also visit PostgreSQL json function and operator documentation to check which operator you expect to use.
This bundle adds some custom functions to allow developers to use such operators.
- Installation
- Adding custom functions to config.yml
- Documentation
- Planned improvements
1. Installation
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
2. Adding custom functions to config.yml(php/xml)
You must add the new functions to be used with DQL into your project's config.yml file, or equivalent if you're using XML, annotations or PHP for config files. If any of the structure is already declared, just append the missing settings.
3. Documentation
From now on you can call one of the functions in your query builder definition in methods as select or andWhere/where, such as:
Functions and operators:
- All functions take two parameters.
- The first parameter is the column name typed as jsonb
- The second parameter can be:
- a single parameter value. Eg:
jsonbbykeytext(jsonbcolumn, 'key') - a string containing a path of json keys separated by comma (,): Eg:
jsonbbypath(jsonbcolumn, 'key1,key2')
- a single parameter value. Eg:
jsonbykey()
Example 1 (single key):
DQL: ->select("jsonbykey(jsonbcolumn, 'key')
SQL Equivalent: SELECT jsonbcolumn->'key' FROM ...
Example 2 (multiple keys):
DQL: ->select("jsonbykey(jsonbcolumn, 'key,key2')
SQL Equivalent: SELECT jsonbcolumn->'key'->'key2' FROM ...
jsonbykeytext()
Example 1 (single key):
DQL: ->select("jsonbykeytext(jsonbcolumn, 'key')
SQL Equivalent: SELECT jsonbcolumn->>'key' FROM ...
Example 2 (multiple keys):
DQL: ->select("jsonbykeytext(jsonbcolumn, 'key,key2')
SQL Equivalent: SELECT jsonbcolumn->>'key'->>'key2' FROM ...
jsonbbypath()
Example 1 (single key):
DQL: ->select("jsonbbypath(jsonbcolumn, 'key')
SQL Equivalent: SELECT jsonbcolumn#>>'{key}' FROM ...
Example 2 (multiple keys):
DQL: ->select("jsonbykeytext(jsonbcolumn, 'key,key2')
SQL Equivalent: SELECT jsonbcolumn#>>'{key, key2}' FROM ...
Planned improvements
There are more operators listed in the official PostgreSQL documentation. The goal is to offer all the operators available. Some native functions may be already be implemented in Doctrine therefore you're encourage to use the native solution instead this package.
