processmaker-builder
Version:
The gulp task runner for ProcessMaker building
423 lines (325 loc) • 24.7 kB
HTML
<html>
<head>
<title>Luracast Restler 3 Live Examples:- </title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="resources/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="resources/highlight.css" />
<link rel="stylesheet" type="text/css" href="resources/style.css" />
<link rel="stylesheet" type="text/css" href="resources/facebox.css" />
<link rel="stylesheet" type="text/css" href="resources/hacks.css" />
<script type="text/javascript" src="resources/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="resources/facebox.js"></script>
<script type="text/javascript" src="resources/bootstrap.min.js"></script>
<script type="text/javascript" src="resources/highlight.pack.js"></script>
<script type="text/javascript">
$(document).ready(
function() {
$('dd pre code').each(function(i, e) {
text = $(e).text();
$(e).addClass(text.charAt(0) == '<' ? 'xml' : 'json')
//hljs.highlightBlock(e);
});
$('pre code').each(function(i, e) {
if($(e).attr('class'))
hljs.highlightBlock(e);
});
$('abbr').parents().not('a').children('abbr').click(
function() {
$('#codeviewer').load(
'resources/getsource.php?file='
+ $(this).attr("title"),
function() {
/*
$("pre#php").snippet("php", {
style : "acid",
showNum : false
});
*/
jQuery.facebox({
div : '#codeviewer'
});
hljs.highlightBlock($("pre#php")[1]);
});
});
var curURL = window.location.pathname.split('/examples/')[1];
if (curURL == '')
curURL = 'index.html';
$("a").each(function() {
if ($(this).attr("href") && $(this).attr("href").indexOf(curURL) > -1) {
$(this).addClass("active");
}
});
$('#right tag').popover({
html : true,
placement : 'left',
trigger : 'manual',
title : 'Tagged Examples',
content : '...'
}).click(function(e) {
$('#right tag').popover('hide');
$(this).popover('show');
e.preventDefault();
e.stopPropagation ? e.stopPropagation() : e.cancelBubble = true;
});
$(document).click(function(e) {
$('#right tag').popover('hide');
});
})
</script>
<!--[if lte IE 8]>
<script type="text/javascript">
(function(){if(!/*@cc_on!@*/0)return;var e = "abbr,article,aside,audio,bb,canvas,datagrid,datalist,details,dialog,eventsource,figure,footer,header,hgroup,mark,menu,meter,nav,output,progress,section,time,video,tag".split(',');for(var i=0;i<e.length;i++){document.createElement(e[i])}})()
</script>
<![endif]-->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23777019-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<nav class="floating-menu">
<ul>
<li><a title="Restler Home" target="_blank" href="http://luracast.com/products/restler/"><img src="resources/home.png" width="16" height="16"/> Home</a></li>
<li><a title="Getting Started with Restler" href=".."><img src="resources/quickstart.png" width="16" height="16"/> Start</a></li>
<!--<li><a title="Using Restler" href="#">Guide</a></li><li><a title="Restler API Reference" href="#">API</a></li>-->
<li><a class="active" href="index.html"><img src="resources/examples.png" width="16" height="16"/> Examples</a></li>
<li><a title="Share your knowledge by answering user questions in Stack Overflow." target="_blank" href="http://bit.ly/Restler-QA"><img src="resources/stackoverflow.png" width="16" height="16"/> Support</a></li>
<li><a title="Contribute and Fork Restler on GitHub" target="_blank" href="http://bit.ly/LuracastRestler"><img src="resources/github.png" width="16" height="16"/> Source</a></li>
<li><a title="Get updated on Twitter" target="_blank" href="http://twitter.com/Luracast"><img src="resources/twitter.png" width="16" height="16"/> Update</a></li>
<li><a title="Keep in touch on Facebook" target="_blank" href="https://www.facebook.com/Luracast"><img src="resources/facebook.png" width="16" height="16"/> Connect</a></li>
</ul>
</nav>
<div id="codeviewer" style="display: none;"></div>
<nav id="left">
<img src="resources/Restler3.gif" width="126"
height="126" title="Luracast Restler 3" />
<h3>
<a href="index.html">Examples</a>
</h3>
<ul>
<li><a href="_001_helloworld/readme.html" title="Let's say hello!">Hello World</a></li>
<li><a href="_002_minimal/readme.html" title="Less is more">Minimal</a></li>
<li><a href="_003_multiformat/readme.html" title="Serving what the client wants">Multi-format</a></li>
<li><a href="_004_error_response/readme.html" title="Making use of HTTP status codes">Error Response</a></li>
<li><a href="_005_protected_api/readme.html" title="Creating restricted zone">Protected API</a></li>
<li><a href="_006_routing/readme.html" title="Ways to map api methods to url">Routing</a></li>
<li><a href="_007_crud/readme.html" title="using POST, GET, PUT and DELETE">CRUD</a></li>
<li><a href="_008_documentation/readme.html" title="Commenting can be more rewarding">Documentation</a></li>
<li><a href="_009_rate_limiting/readme.html" title="Abuse no more">Rate Limiting</a></li>
<li><a href="_010_access_control/readme.html" title="Who can do what">Access Control</a></li>
<li><a href="_011_versioning/readme.html" title="using the URL">Versioning</a></li>
<li><a href="_012_vendor_mime/readme.html" title="custom media type for versioning">Vendor MIME</a></li>
<li><a href="_013_html/readme.html" title="rendering custom views">Html Format</a></li>
<li><a href="_014_oauth2_client/readme.html" title="to consume protected API">OAuth2 Client</a></li>
<li><a href="_015_oauth2_server/readme.html" title="offering protected API">OAuth2 Server</a></li>
<li><a href="_016_forms/readme.html" title="to capture user input">Forms</a></li>
</ul>
</nav>
<nav id="right">
<h3><a href="index.html">Examples by Tag</a></h3>
<ul class="tags">
<li><tag title="Access-control Example(s)" data-content="<a href="_010_access_control/readme.html">Access Control</a> <a href="_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="_015_oauth2_server/readme.html">OAuth2 Server</a>">access-control</tag><badge>3</badge></li>
<li><tag title="Acl Example(s)" data-content="<a href="_010_access_control/readme.html">Access Control</a> <a href="_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="_015_oauth2_server/readme.html">OAuth2 Server</a>">acl</tag><badge>3</badge></li>
<li><tag title="Authentication Example(s)" data-content="<a href="_005_protected_api/readme.html">Protected API</a> <a href="_010_access_control/readme.html">Access Control</a> <a href="_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="_015_oauth2_server/readme.html">OAuth2 Server</a>">authentication</tag><badge>4</badge></li>
<li><tag title="Authorization Example(s)" data-content="<a href="_005_protected_api/readme.html">Protected API</a> <a href="_010_access_control/readme.html">Access Control</a> <a href="_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="_015_oauth2_server/readme.html">OAuth2 Server</a>">authorization</tag><badge>4</badge></li>
<li><tag title="Basic Example(s)" data-content="<a href="_001_helloworld/readme.html">Hello World Example</a> <a href="_002_minimal/readme.html">Minimal Example</a>">basic</tag><badge>2</badge></li>
<li><tag title="Blade Example(s)" data-content="<a href="_016_forms/readme.html">Forms Example</a>">blade</tag></li>
<li><tag title="Bootstrap Example(s)" data-content="<a href="_016_forms/readme.html">Forms Example</a>">bootstrap</tag></li>
<li><tag title="Create Example(s)" data-content="<a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">create</tag><badge>3</badge></li>
<li><tag title="Custom Example(s)" data-content="<a href="_012_vendor_mime/readme.html">Vendor MIME</a>">custom</tag></li>
<li><tag title="Debug Example(s)" data-content="<a href="_008_documentation/readme.html">Documentation</a>">debug</tag></li>
<li><tag title="Delete Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a> <a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">delete</tag><badge>4</badge></li>
<li><tag title="Doc Example(s)" data-content="<a href="_008_documentation/readme.html">Documentation</a>">doc</tag></li>
<li><tag title="Emmet Example(s)" data-content="<a href="_016_forms/readme.html">Forms Example</a>">emmet</tag></li>
<li><tag title="Exception Example(s)" data-content="<a href="_004_error_response/readme.html">Error Response</a>">exception</tag></li>
<li><tag title="Filter Example(s)" data-content="<a href="_009_rate_limiting/readme.html">Rate Limiting</a>">filter</tag></li>
<li><tag title="Form Example(s)" data-content="<a href="_016_forms/readme.html">Forms Example</a>">form</tag></li>
<li><tag title="Foundation Example(s)" data-content="<a href="_016_forms/readme.html">Forms Example</a>">foundation</tag></li>
<li><tag title="Get Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a> <a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">get</tag><badge>4</badge></li>
<li><tag title="Handlebar Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">handlebar</tag></li>
<li><tag title="Html Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a> <a href="_016_forms/readme.html">Forms Example</a>">html</tag><badge>2</badge></li>
<li><tag title="Http Status Example(s)" data-content="<a href="_002_minimal/readme.html">Minimal Example</a> <a href="_004_error_response/readme.html">Error Response</a>">http status</tag><badge>2</badge></li>
<li><tag title="Json Example(s)" data-content="<a href="_003_multiformat/readme.html">Multi-format</a>">json</tag></li>
<li><tag title="Mediatype Example(s)" data-content="<a href="_012_vendor_mime/readme.html">Vendor MIME</a>">mediatype</tag></li>
<li><tag title="Mime Example(s)" data-content="<a href="_012_vendor_mime/readme.html">Vendor MIME</a>">mime</tag></li>
<li><tag title="Mustache Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">mustache</tag></li>
<li><tag title="Patch Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a>">patch</tag></li>
<li><tag title="Php Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">php</tag></li>
<li><tag title="Post Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a> <a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">post</tag><badge>4</badge></li>
<li><tag title="Production Example(s)" data-content="<a href="_008_documentation/readme.html">Documentation</a>">production</tag></li>
<li><tag title="Put Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a> <a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">put</tag><badge>4</badge></li>
<li><tag title="Rate-limiting Example(s)" data-content="<a href="_009_rate_limiting/readme.html">Rate Limiting</a>">rate-limiting</tag></li>
<li><tag title="Read Example(s)" data-content="<a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">read</tag><badge>3</badge></li>
<li><tag title="Retrieve Example(s)" data-content="<a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">retrieve</tag><badge>3</badge></li>
<li><tag title="Routing Example(s)" data-content="<a href="_006_routing/readme.html">Routing</a> <a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a>">routing</tag><badge>3</badge></li>
<li><tag title="Secure Example(s)" data-content="<a href="_010_access_control/readme.html">Access Control</a> <a href="_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="_015_oauth2_server/readme.html">OAuth2 Server</a>">secure</tag><badge>3</badge></li>
<li><tag title="Template Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">template</tag></li>
<li><tag title="Throttle Example(s)" data-content="<a href="_009_rate_limiting/readme.html">Rate Limiting</a>">throttle</tag></li>
<li><tag title="Twig Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">twig</tag></li>
<li><tag title="Update Example(s)" data-content="<a href="_007_crud/readme.html">CRUD</a> <a href="_008_documentation/readme.html">Documentation</a> <a href="_009_rate_limiting/readme.html">Rate Limiting</a>">update</tag><badge>3</badge></li>
<li><tag title="Validation Example(s)" data-content="<a href="_002_minimal/readme.html">Minimal Example</a> <a href="_004_error_response/readme.html">Error Response</a> <a href="_016_forms/readme.html">Forms Example</a>">validation</tag><badge>3</badge></li>
<li><tag title="Vendor Example(s)" data-content="<a href="_012_vendor_mime/readme.html">Vendor MIME</a>">vendor</tag></li>
<li><tag title="Versioning Example(s)" data-content="<a href="_011_versioning/readme.html">Versioning</a> <a href="_012_vendor_mime/readme.html">Vendor MIME</a>">versioning</tag><badge>2</badge></li>
<li><tag title="View Example(s)" data-content="<a href="_013_html/readme.html">Html Format</a>">view</tag></li>
<li><tag title="Xml Example(s)" data-content="<a href="_003_multiformat/readme.html">Multi-format</a>">xml</tag></li>
</ul>
</nav>
<article id="page">
<p><a id="live-examples" class="anchor"></a><h2>Live Examples</h2></p>
<p>Luracast Restler 3 is a micro-framework that can expose any PHP class
(with zero arguments constructor) and its public and protected methods (that
manage their own dependencies) as RESTful API.</p>
<p><strong>Learn by the examples</strong></p>
<p>Here you can find the examples that shows many features of Restler and
how to use them. It is created in such a way that they can be tested
on your local host. You can check the source code, try some of the API's
exposed all at the comfort of your browser</p>
<ol class="toc">
<li><a href="_001_helloworld/readme.html" title="Basic hello world example to get started with Restler 3.">
<span>Hello World
<small><i>Let's say hello!</i></small>
</span> <span class="right"> 1</span></a></li>
<li><a href="_002_minimal/readme.html" title="Shows the bare minimum code needed to get your RESTful api server
up and running">
<span>Minimal
<small><i>Less is more</i></small>
</span> <span class="right"> 2</span></a></li>
<li><a href="_003_multiformat/readme.html" title="This BMI calculator service shows how you can serve data in different
formats using Restler. This example uses JsonFormat (default) and XmlFormat...">
<span>Multi-format
<small><i>Serving what the client wants</i></small>
</span> <span class="right"> 3</span></a></li>
<li><a href="_004_error_response/readme.html" title="API methods can make use of RestException class to provide
error information to the user.
use `throw new RestException($httpStatusCode)` to send the error response
to the client...">
<span>Error Response
<small><i>Making use of HTTP status codes</i></small>
</span> <span class="right"> 4</span></a></li>
<li><a href="_005_protected_api/readme.html" title="Not all the API exposed needs to be public, we need to protect
some of our API.
Here are three ways to protect a method
1...">
<span>Protected API
<small><i>Creating restricted zone</i></small>
</span> <span class="right"> 5</span></a></li>
<li><a href="_006_routing/readme.html" title="### Two ways of Routing
API Methods can be mapped to URI in two ways
1. Automatic Routing
2. Manual Routing
### How automatic routing is done?
**Role of Class Name**
When the api class is added without specifying the path prefix, name of the
class will be used as path prefix
**Mapping to HTTP Verbs (GET, POST, PUT, DELETE, PATCH)**
Restler uses *get, put, post, delete, and patch* as prefix to map PHP methods to
respective HTTP methods...">
<span>Routing
<small><i>Ways to map api methods to url</i></small>
</span> <span class="right"> 6</span></a></li>
<li><a href="_007_crud/readme.html" title="Create, Retrieve, Update and Delete using
HTTP methods POST, GET, PUT and DELETE respectively.
Restler uses *get, put, post, and delete* as prefix to map PHP methods to
respective HTTP methods...">
<span>CRUD
<small><i>using POST, GET, PUT and DELETE</i></small>
</span> <span class="right"> 7</span></a></li>
<li><a href="_008_documentation/readme.html" title="How to document and let your users explore your API.
We have modified SwaggerUI to create
[Restler API Explorer](https://github...">
<span>Documentation
<small><i>Commenting can be more rewarding</i></small>
</span> <span class="right"> 8</span></a></li>
<li><a href="_009_rate_limiting/readme.html" title="How to Rate Limit API access using a Filter class that implements
`iFilter` interface.
This example also shows how to use Defaults class to customize defaults, how to create your own
iCache implementation, and how to make a hybrid filter class that behaves differently
when the user is Authenticated
[![Restler API Explorer](...">
<span>Rate Limiting
<small><i>Abuse no more</i></small>
</span> <span class="right"> 9</span></a></li>
<li><a href="_010_access_control/readme.html" title="This example shows how you can extend the authentication system to create
a robust access control system...">
<span>Access Control
<small><i>Who can do what</i></small>
</span> <span class="right"> 10</span></a></li>
<li><a href="_011_versioning/readme.html" title="This example shows how to version your API using namespace. Restler supports
both url based versioning (this example) and vendor specific media type
versioning (next example)...">
<span>Versioning
<small><i>using the URL</i></small>
</span> <span class="right"> 11</span></a></li>
<li><a href="_012_vendor_mime/readme.html" title="This example shows how to use vendor specific media types for versioning
###Vendor-Specific Media Types
> Media types use the subtype prefix `vnd` to indicate that they are owned and
> controlled by a `vendor`...">
<span>Vendor MIME
<small><i>custom media type for versioning</i></small>
</span> <span class="right"> 12</span></a></li>
<li><a href="_013_html/readme.html" title="A special format that lets us render a template with the api result
It currently supports the following template libraries/formats
- php (default)
- mustache / handlebar (requires `"mustache/mustache"`)
- twig (requires `"twig/twig"`)
- Laravel 4 blade templates (requires `"illuminate/view"`)
When HtmlFormat is used with out defining a view it uses debug view to present
data and more information
[![Debug View](...">
<span>Html Format
<small><i>rendering custom views</i></small>
</span> <span class="right"> 13</span></a></li>
<li><a href="_014_oauth2_client/readme.html" title="### Setting up the client example
In order to run this example on your localhost do the following
1...">
<span>OAuth2 Client
<small><i>to consume protected API</i></small>
</span> <span class="right"> 14</span></a></li>
<li><a href="_015_oauth2_server/readme.html" title="### Setting up the server example
In order to run this example on your localhost do the following
1...">
<span>OAuth2 Server
<small><i>offering protected API</i></small>
</span> <span class="right"> 15</span></a></li>
<li><a href="_016_forms/readme.html" title="Forms is a utility class that builds web forms in one of the following in built styles
- Plain Html 5
- Twitter Bootstrap 3
- Zerb Foundation 5
```php
use Luracast/Restler/UI/Forms;
use Luracast/Restler/UI/FormStyles;
Forms::$style = FormStyles::$bootstrap3; // FormStyles::$foundation5;
```
Where ever you need the generated forms (typically in view templates) just call
```php
echo Forms::get('POST','user/signup');
```
If you are using twig templates you can use the following instead
{{ form('POST', 'user/signup') }}
## Emmet Templates
Forms is using Emmet templates, with which adding more styles is very easy
Emmet Templates is built with a subset of Emmet as in [emmet...">
<span>Forms
<small><i>to capture user input</i></small>
</span> <span class="right"> 16</span></a></li>
</ol>
<p> </p>
<p> <img src="resources/restler_flow.png" alt="Restler Flow Diagram" title="Restler Flow" width="100%">
<strong>Restler Execution Flow</strong>
</p>
<p> </p>
<p> </p>
<p> </p>
</article>
<footer>
© 2010 <a title="Luracast.com" href="http://luracast.com"><img src="resources/Luracast_dark.png" width="180" height="32" title="Helping Developers with Tools, Utilities, Frameworks and Services"/></a>
</footer>
</body>
</html>