Added syntax highlighting

This commit is contained in:
Montana Flynn
2013-04-16 14:43:34 -07:00
parent e759cfb8dd
commit 14a784e416

View File

@@ -14,40 +14,47 @@ Download the PHP library from Github, and require in your script like so:
### Creating Request ### Creating Request
So you're probably wondering how using Unicorn makes creating requests in PHP easier, let's look at a working example: So you're probably wondering how using Unicorn makes creating requests in PHP easier, let's look at a working example:
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ), ```php
array( $response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
"parameter" => 23, array(
"foo" => "bar" "parameter" => 23,
) "foo" => "bar"
); )
);
```
### File Uploads ### File Uploads
To upload files in a multipart form representation simply place an @ symbol before the path: To upload files in a multipart form representation simply place an @ symbol before the path:
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ), ```php
array( $response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
"file" => "@/tmp/file.txt" array(
) "file" => "@/tmp/file.txt"
); )
);
```
### Custom Entity Body ### Custom Entity Body
Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body: Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body:
```php
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ), $response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
json_encode( json_encode(
array( array(
"parameter" => "value", "parameter" => "value",
"foo" => "bar" "foo" => "bar"
) )
) )
); );
```
### Request Reference ### Request Reference
Unicorn::get($url, $headers = array()); ```php
Unicorn::post($url, $headers = array(), $body = NULL); Unicorn::get($url, $headers = array());
Unicorn::put($url, $headers = array(), $body = NULL); Unicorn::post($url, $headers = array(), $body = NULL);
Unicorn::patch($url, $headers = array(), $body = NULL); Unicorn::put($url, $headers = array(), $body = NULL);
Unicorn::delete($url, $headers = array()); Unicorn::patch($url, $headers = array(), $body = NULL);
Unicorn::delete($url, $headers = array());
```
`url` `url`
Endpoint, address, or uri to be acted upon and requested information from. Endpoint, address, or uri to be acted upon and requested information from.