Module Resource - Opa Documentation

About this module

This modules provides the necessary functions to define and export resources, such as images,
web pages, error pages, etc. as well as customizing pages for display on platforms with specific
needs (e.g. PDAs, iPhone, etc.)

Where do I start?

To create a web page, use function Resource.page or its shortcut html. To create an image,
use function Resource.image. OPA will handle the details.

What if I need more?

To add new kinds of resources, such as videos or mp3, use Resource.binary or its cousinResource.source. To customize pages, use Resource.full_page.

type

Resource.cache

Variant

```
   
```
```
{ 
```
void
```
 
```
volatile
```
 }
```
```
or 
```
```
{ 
```
Date.date
```
 
```
modified_on
```
 }
```
```
or 
```
```
{ 
```
Duration.duration
```
 
```
check_for_changes_after
```
 }
```
```
or 
```
```
{ 
```
void
```
 
```
permanent
```
 }
```

type

Resource.doctype

html_resource_doctype

type

Resource.resource

Name	Summary
add_auto_server
add_auto_simple_server	Complete given parser by adding automatic handling of files contained on given map
add_header
add_headers
add_permanent_to_server
add_permanent_to_simple_server
base_url
binary	Build a resource from some binary content.e.g. to embed statically a mp3, use .
build_css	Build a css from some content.
cache_control
create_dynamic_resource	Build a dynamic resource from the name of the file and its type. Same as but with status set to
create_dynamic_resource_status	Build a dynamic resource from the name of the file, its type and its status.
default_error_page	Build the default web page for displaying an error.Note that this page is rather ugly. You should ra...
default_redirection_page	Build the default web page for redirecting the user to another address.Note that this page is rather...
dyn_image
dynamic	Create a resource which is recomputed at each time it is served.
dynamic_to_resource	Convert a dynamic resource to a resource
error_page	Build a web page for displaying an error.See also if you don't care about the appearance of the err...
export_data
full_page	Build a web page.This function is a more powerful variant on .
full_page_with_doctype
get_content
get_uri_of_null
get_uri_of_permanent
html	An alias for
image	Build an image from some content.
iphone_customizer	A standard customizer to add an icon and a start-up image for applications running on iPhone OS.
json	Build some pure text content.
later	Build a delegated result : this value makes the server does not give back anything to the client thi...
override_type_unsafe	Override the mime type of a resourceNote: This is an unsafe operation, as some browsers base their s...
page	Build a web page.This function is sufficient for most uses. If you need to more control on the page,...
raw_response	Build a resource from some raw content. Note: If you put status to , this is equivalent to .e.g. to ...
raw_status	Build a resource containing only a status (empty content)e.g. to send a 409, use .
raw_text	Build some pure text content.
redirection_page	Build a redirection page.See also if you don't care about the appearance of the redirection page.
register_default_doctype	Set the default doctype of html pages.
register_external_css	Adds an external css file (identified by its url) to the default_customizers of ALL resources. Will ...
register_external_favicon	Adds an favicon link to the default_customizers of ALL resources. Will be appended in the headers of...
register_external_js	Adds an external javascript file (identified by its url) to the default_customizers of ALL resources...
soap	* Construct a SOAP resource. * * @param soap A response defined in XML. As per SOAP definition, ...
source	Build a resource from some ascii content.e.g. to embed statically a source code, use .
static_page
static_styled_page
status_control	Change the status of a resource
styled_page	Build a web page, adding a set of stylesheets.This function is sufficient for most uses. If you need...
unregister_external_css	Removes an external css file (identified by its url) to the default_customizers of ALL resources if ...
unregister_external_js	Removes an external javascript file (identified by its url) to the default_customizers of ALL resour...
update_dynamic	Update a dynamic resource if it changed
update_dynamic_status	Update a dynamic resource status if it changed
xml	Build some xmlns content

About this module

Where do I start?

What if I need more?

Comments