Search results for "StructrScript"

A StructrScript context is explicitly defined by ${} and automatically assumed within auto-scripting contexts.

The return value of a StructrScript expression is determined by resolving the nested functions from the inside out.

The StructrScript mode can be used to test the behaviour of StructrScript expressions or perform very simple maintenance tasks.

StructrScript is the name of the internal scripting language that can be used in Content or Template nodes, Template Expressions, Show Conditions and HTML attributes. It is a simple interpreted functional scripting language that provides access to Structr’s functionality through a set of functions and keywords. StructrScript has no control structures, it is interpreted like a fully functional language, although some of the Built-In Functions have side effects.

If the value of a constant is an object, its contents can be dereferenced using dot notation.

Most keywords can be used in JavaScript and StructrScript contexts. In a StructrScript context, they can be used directly. In a JavaScript context the can be used via the $.get(<keyword>) function (or since release 3.5 also via $.<keyword>).

JavaScript-only keywords are made available by functions.

To add functionality to the flow, we will add a small StructrScript snippet to query existing users in the database. Left-click the Script text box of the Action element to bring up a code editor and enter the script as shown below.

For HTML elements, Structr offers two additional ways to control the visibility during page rendering: showConditions and hideConditions. Both can contain a StructrScript or Javascript expression and - if they are filled - are evaluated before rendering. Depending on the return value of the script, the current element and its substructure will be displayed or hidden. Both fields are auto-script environments, i.e. the text in those fields is interpreted as a script without the need for the template expression markers ${...}.

Depending on the context, different kinds of Scripting environments and scopes are possible. In auto-scripting environments, Structr will automatically assume any code to be StructrScript, unless otherwise specified. Within this context, it’s possible to define other scripting environments by using a special notation similar to how explicit scripting contexts are defined. These special notation is further explained in the section for each specific scripting language.

For JavaScript and StructrScript, the output on the console is the same as if you were executing the expression in a scripting context of a content element or template element.

Most of the processes in Structr are event-driven: things happen when database objects are created, modified or deleted. For these events, Structr provides lifecycle methods that you can implement on any type in the data model (even the built-in types), using either StructrScript or Javascript.

The console supports five different modes that you can cycle through using Shift - Tab:

• JavaScript
• StructrScript
• Cypher
• AdminShell
• REST

In addition to JavaScript, a simplified script language called StructrScript is also supported, which is particularly suitable for short script expressions as well as simple text formatting and variable replacement.

In the JavaScript context the same built-in functions are available as in the StructrScript context but a lot of convenient JavaScript functionality is available as well.

In the function repeater the complete contents of the text area are interpreted as a script. By default as StructrScript but by adding { before and } after the code, it will be interpreted as JavaScript. All options described in the scripting guide are available in this scripting context.

In the StructrScript context all built-in functions can be used to collect, filter, sort, etc. the data for the repeater.

MessageSubscriber is a generic abstraction of a subscriber included in the Messaging-Engine Module module.
It can attach to any kind of MessageClient and will subscribe on that client with the specified topic.
If the client receives a message on given topic, a callback will be made to the subscriber and the message will be evaluated in a scripting context that is specified in the subscribers callback attribute.

The following properties can be configured for the subscriber:

Note: Instead of using a specific topic, it is also possible to use * as a wildcard subscription.
The default scripting context is StructrScript and the message’s content is injected as well and available via retrieve() under the following attributes.