https://github.com/zircote/hal
A PHP implementation of HAL http://stateless.co/hal_specification.html
https://github.com/zircote/hal
Last synced: about 1 year ago
JSON representation
A PHP implementation of HAL http://stateless.co/hal_specification.html
- Host: GitHub
- URL: https://github.com/zircote/hal
- Owner: zircote
- Created: 2012-02-27T22:34:57.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2015-04-25T06:04:54.000Z (about 11 years ago)
- Last Synced: 2025-04-09T21:18:21.431Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 256 KB
- Stars: 94
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG
- License: LICENSE-2.0.txt
Awesome Lists containing this project
README
# Hal
[](http://travis-ci.org/zircote/Hal)
* [HAL IETF Draft](http://tools.ietf.org/html/draft-kelly-json-hal)
* [HAL Specification](http://stateless.co/hal_specification.html)
* [Hal Specification on Github](https://github.com/mikekelly/hal_specification)
* [JSON Linking With HAL](http://blog.stateless.co/post/13296666138/json-linking-with-hal)
* [Linking In Json](http://www.mnot.net/blog/2011/11/25/linking_in_json)
* [Examples of HAL](https://gist.github.com/2289546)
* [HAL on Google Groups](https://groups.google.com/d/forum/hal-discuss)
```php
setLink(new Link('/dogs?q={text}', 'search'));
$dogs[1] = new Resource('/dogs/1');
$dogs[1]->setData(
array(
'id' => '1',
'name' => 'tiber',
'color' => 'black'
)
);
$dogs[2] = new Resource(
'/dogs/2',array(
'id' => '2',
'name' => 'sally',
'color' => 'white'
)
);
$dogs[3] = new Resource(
'/dogs/3',array(
'id' => '3',
'name' => 'fido',
'color' => 'gray'
)
);
/* Add the embedded resources */
foreach ($dogs as $dog) {
$parent->setEmbedded('dog', $dog);
}
echo (string) $parent;
```
### Result:
```javascript
{
"_links":{
"self":{
"href":"\/dogs"
},
"search":{
"href":"\/dogs?q={text}"
}
},
"_embedded":{
"dog":[
{
"_links":{
"self":{
"href":"\/dogs\/1"
}
},
"id":"1",
"name":"tiber",
"color":"black"
},
{
"_links":{
"self":{
"href":"\/dogs\/2"
}
},
"id":"2",
"name":"sally",
"color":"white"
},
{
"_links":{
"self":{
"href":"\/dogs\/3"
}
},
"id":"3",
"name":"fido",
"color":"gray"
}
]
}
}
```
## Generating XML output
```php
getXML()->asXML();
```
### Result:
```xml
1
tiber
black
2
sally
white
3
fido
gray
```
[](https://bitdeli.com/free "Bitdeli Badge")