PHP download

Download the PHP package mk/hal without Composer

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

Table of contents
Download mk/hal
More information about mk/hal
Files in mk/hal

Vendor mk
Package hal
Short Description Implementation of HAL standart for using in REST API responses or similiar
License MIT

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 mk/hal

Informations about the package hal

MKHal

This repository is still in a early development stage. If you find any issues or miss any feature please feel free to raise an issue.

MKHal is an implementation of the HAL specification written in PHP. It can be used to build a HAL specific data structure and convert it to JSON or XML. It can be easily implemented in your current API backend workflow.

Requirements

PHP 7.0 or higher

Installation

You can clone or download the package and use it in your project or just install it via composer:

Usage

Object types

MKHal offers different class types to represent the structure of a typical HAL implementation:

HALObject: The HALObject class represents the main resource in the HAL specification. It can hold normal data, HALLink objects and HALCurie objects. It can also embed additional HALObjects in referred by labels.
HALLink: The HALLink class represents a typical link resources in the _links section of the HAL document. It can hold different information like the href attribute. It get automatically serialized along with an HALObject instance. A HALObject can hold additional links after different labels.
HALCurie: The HALCurie class is the representation of the curies attribute in HAL. An HALObject instance can have multiple curies inside of it.

Basic usage

The call of the export() method creates a JSON representation of the HAL specification:

Roadmap

[x] Implement basic HAL specification
[x] Enable curies
[x] Well structured class hierarchy
[x] JSON export / output
[x] Auto create HAL data from given objects
[ ] XML export / output
[ ] Read HAL objects to use library as client too
[ ] Slim Framework integration

All versions of hal with dependencies

PHP Build Version

Package Version

Version 2.0.1 Release 04. Feb 2019
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of hal from vendor mk

No informations.

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 mk/hal contains the following files

Loading the files please wait ....