env

Provides access to resources in the plugin environment. In generally, this will be files stored in a Complex Plugin's folder.

API Overview

API Documentation

Constructors

new

Signature

cp.plugins.env.new(rootPath) -> cp.plugins.env

Type

Constructor

Description

Creates a new env pointing at the specified root folder path.

Parameters

Returns

Methods

Signature

cp.plugins.env:compileTemplate(view[, layout]) -> function

Type

Method

Description

Compiles a Resty Template within the context of the plugin. The view may be a resource path pointing at a template file in the plugin, or may be raw template markup. The layout is an optional path/template for a layout template. See the Resty Template documentation for details.

Parameters

Returns

Signature

cp.plugins.env:pathToAbsolute(resourcePath) -> string

Type

Method

Description

Returns the absolute path to the file referred to by the relative resource path. If an image is stored as images/my.jpg in the plugin, the resource path will be "images/my.jpg". The result will be the full path to that file. If the file cannot be found in the plugin, it will look in the cp/resources/assets folder for globally-shared resources.

Parameters

Returns

pathToURL

Signature

cp.plugins.env:pathToURL(resourcePath) -> string

Type

Method

Description

Returns an absolute file:// URL to the file referred to by the relative resource path. If an image is stored as images/my.jpg in the plugin, the resource path will be "images/my.jpg". The result will be a URL to that file. If the file cannot be found in the plugin, it will look in the cp/resources/assets folder for globally-shared resources.

Parameters

Returns

Signature

cp.plugins.env:readResource(resourcePath) -> string

Type

Method

Description

Reads the contents of the resource at the specified resource path. This is returned as a string of data (which may or may not be an actual readable string, depending on the source content).

Parameters

Returns

Signature

cp.plugins.env:renderTemplate(view[, model[, layout]]) -> string

Type

Method

Description

Renders a Resty Template within the context of the plugin. The view may be a resource path pointing at a template file in the plugin, or may be raw template markup. The layout is an optional path/template for a layout template. See the Resty Template documentation for details.

Parameters

Returns