Download the PHP package sigep/request without Composer
On this page you can find all versions of the php package sigep/request. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sigep/request
More information about sigep/request
Files in sigep/request
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 request
Request
This package aims to facilitate the parse of the querystring and get some information about what data the user want to obtain.
(!) This package just parses the querystring and returns a formatted array. It doesn't interact with the database or anything like it. The data that will be returned and the application of the filters, orderings, etc, depends of the implementation of the application.
Installation:
Add the repository and declare the dependency in your composer.json.
Run the following command:
Usage
The Request supports pagination, ordinations, filters and searches.
Pagination
To pagination, Request uses the page and offset parameters.
Examples:
- The first request will obtain all cities;
- The second will return the second page of the list. By default, the offset is set to 15, so only 15 cities will be returned;
- The third will return the first 100 cities. The request doesn't specify the page, but defines a offset, so Request assumes that is the first page;
- The fourth request will return the second page of the list, with offset of 100.
To determine if the request wants pagination or not, you use:
To get the page requested, use:
To get the offset, use:
To set a default offset (the package default is 15), use:
Embed
Sometimes the resources have relationships with other resources and you want to be able to provide those relationships if the user want them. The embed parameter is used in those situations.
Examples:
- The first request will return all cities and each one will have it's country;
- The second will return all cities with country and state.
To get the the list of embedded relationships, use:
Ordination
You can sort the list of objects by any of its properties.
Examples:
- The first request will return the list of cities ordered by name A-Z;
- The second will return the list of cities ordered by name Z-A;
- The third will return the list of cities ordered by state A-Z and name A-Z;
To get the parameters to ordination, use:
Search
Examples:
- The above request will search for cars with
peugeot. The query can be performed checking the name, description, brand or anything that the resource has.
To get the parameter, use:
It's up to the application define how the search will be performed and the operators that will be used (equals, like etc).
Filters
Filters allow you to filter the results based on its properties.
Examples:
- The first request will return a list of all female users;
- The second will return a list of female users that are older then 20 years;
- The third will return a list of users that are older then 20 and younger then 30 years (between 20 and 30 exclusive);
- The third will return a list of users that have 20 years or more and 30 years or less (between 20 an 30 inclusive);
- The fourth will return a list of users that have 20 or 30 years;
To get the filters parameters, use:
Note that the filters are parameters on the querystring. Some words are reserved by other methods, like page, offset and sort.
For more information, explore the source :)
Written with StackEdit.
