Download the PHP package stormsys/simplehal without Composer

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

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 stormsys/simplehal

Informations about the package simplehal

SimpleHAL

Total Downloads

SimpleHal is an easy to use library for consuming Hal API's.

Installation using Composer

Add the dependency:

Limitations

Currently the library supports only GET requests, there are plans to add support for PUT, POST and DELETE in the future.

Usage

Setup Root Resource

This examples shows how to setup a root resource to begin nagivation.

Following Non-Templated Links

once you have obtained a resource, SimpleHal offers several ways to follow links.

Simple hal offers powerful php overloading mechanisms(see note on magic methods below) for making the api more fluent, the line above can also be represented as such:

Following Templated Links

Similar to the above, you can follow templated links by providing the template variables like so.

and again with the overload(see note on magic methods below).

Reading Embedded Resources

Sometimes partial, incomplete or full resources are embedded into the hal document, these are accessible using the embedded function like so.

Magic acessors are also avaliable for embedded resources (see magic methods below).

Reading Resource Properties

To access properties of a resource, you can use the prop method shown below.

As eith following relations and embedded resources, magic acessors are avalible for properties (see magic methods below).

below are all equivlant ways to access the property.

Refresh / Obtain Full Representations

You can update or refresh resources that you have already loaded by calling refresh()

or in the event that you are using a embedded partial resource as long as a self link is present you can use, this is just an alias for ->refresh().

Chain Example

The example below shows how you might chain methods to obtain some data on a hal api.

Magic Methods

You can access embedded resources, follow links and access proprties through the magic acessors and method overloads. the name of the field/method will be equal to the relation or the property name.

the order in which SimpleHal will attempt to resolve the request is:

is it impoarant to understand the order which requests are resolved as the library will pick the first one that is found, in the event of duplicates an embedded resource will be picked over the others, and following a link before a property.

Interfaces

The library offer the following interfaces which can be custom implemented.

by default the library has bundled the following implementations:

TODO

All versions of simplehal with dependencies

PHP Build Version
Package Version
Requires league/url Version 3.2.1
guzzlehttp/guzzle Version ~5.0
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 stormsys/simplehal contains the following files

Loading the files please wait ....