Download the PHP package label305/dug without Composer
On this page you can find all versions of the php package label305/dug. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package dug
Short Description Adding elegance to defining your webservices
License Apache-2.0
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 dug
Dug
For combining different data sources to create webservice responses efficiently and manageable.
Experimental
This library is highly experimental, use at your own risk!
The problem
When managing a RESTful api you want responses to be consistent and composable, for example fetching a user:
This often requires the combination of fetching a user and adding an
friend_count. While this is manageable for a single user,
when you want to include a user object inside of another object, you
have to make sure these fields are included to be consistent.
While your api grows it is harder to see how every object is composed, this is where Dug comes into play.
Dug allows you to point to sources providing certain data, each of these sources can refer to one another and compose their data.
Basic usage
First of all we setup a dug
Then register your first data fetching source, which will fetch a bunch
of users from the database. Note that $path[1] contains an array with results
that matched /[0-9]+/ so you can combine the query.
To fetch data you can request data from a source:
Which will result in the array:
Composing
Let's take the example from Basic usage but in this case we add the unread count
Since the first argument of Data::build (the source) will be the same
for fetching user data, as well as for fetching the unread counts; e.g.
['users', 1]. Dug knows it can combine the results of those two.
References
Now imagine we have users who belong to a company, so you'll have an
endpoint called companies/1 to fetch a single company, but you'll
also have an endpoint users/2 to fetch a single user. Since every
user has only one company and the company specification doesn't change
that much, you'll probably want to include the company directly within
the user object, as so:
Now a problem arises, you have a definition what a company looks like
in your api, but you want to keep them in sync between the companies/1
and users/1 endpoint. This is where references come in.
This assumes you have registered another source ['companies', '/[0-9]+/']
which will return companies. Dug will resolve the reference by fetching
data from this source and merge it with the user object.
Since Dug first combines al data it will also combine all references
to check if it can combine calls to your ['companies', '/[0-9]+/']
source in case you fetched multiple users, and possibly multiple companies.
Meaning it will make only one round trip to your ['companies', '/[0-9]+/']
source!
Dependency Injection
When your api grows you don't want everything done within closures, for this
we have DataProvider classes. For example:
Which you can register as a source by their classname:
By default Dug will simply create an instance of this class, however
since you might have a dependency injection framework lying around you
might want to use that to initiate classes and inject stuff into your
constructor. This can be done using a ClassInitializer:
License
Copyright 2016 Label305 B.V.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
