References
Built-in Functions
Database Functions
| Name | Description | |
|---|---|---|
addLabels() | Adds the given set of labels to the given node. | Show detailsHide details |
create() | Creates a new node with the given type and key-value pairs in the database. | Show detailsHide details |
createOrUpdate() | Creates an object with the given properties or updates an existing object if it can be identified by a unique property. | Show detailsHide details |
createRelationship() | Creates and returns relationship of the given type between two entities. | Show detailsHide details |
cypher() | Executes the given Cypher query directly on the database and returns the results as Structr entities. | Show detailsHide details |
delete() | Deletes the one or more nodes or relationships from the database. | Show detailsHide details |
find() | Returns a collection of entities of the given type from the database. | Show detailsHide details |
findPrivileged() | Executes a find() operation with elevated privileges. | Show detailsHide details |
findRelationship() | Returns a collection of relationship entities of the given type from the database, takes optional key/value pairs. | Show detailsHide details |
get() | Returns the value with the given name of the given entity, or an empty string. | Show detailsHide details |
getIncomingRelationships() | Returns all incoming relationships between the given nodes, with an optional qualifying relationship type. | Show detailsHide details |
getOrCreate() | Returns an entity with the given properties, creating one if it doesn’t exist. | Show detailsHide details |
getOrNull() | Returns the value with the given name of the given entity, or null. | Show detailsHide details |
getOutgoingRelationships() | Returns the outgoing relationships of the given entity with an optional relationship type. | Show detailsHide details |
getRelationships() | Returns the relationships of the given entity with an optional relationship type. | Show detailsHide details |
hasIncomingRelationship() | Returns true if the given entity has incoming relationships of the given type. | Show detailsHide details |
hasOutgoingRelationship() | Returns true if the given entity has outgoing relationships of the given type. | Show detailsHide details |
hasRelationship() | Returns true if the given entity has relationships of the given type. | Show detailsHide details |
incoming() | Returns all incoming relationships of a node, with an optional qualifying relationship type. | Show detailsHide details |
instantiate() | Converts the given raw Neo4j entity to a Structr entity. | Show detailsHide details |
isEntity() | Returns true if the given argument is a Structr entity (node or relationship). | Show detailsHide details |
jdbc() | Fetches data from a JDBC source. | Show detailsHide details |
mongodb() | Opens a connection to a MongoDB source and returns a MongoCollection which can be used to further query the Mongo database. | Show detailsHide details |
outgoing() | Returns all outgoing relationships of a node, with an optional qualifying relationship type. | Show detailsHide details |
prefetch() | Prefetches a subgraph. | Show detailsHide details |
prefetch2() | Prefetches a subgraph using a query that returns explicit node and relationship collections. | Show detailsHide details |
remoteCypher() | Returns the result of the given Cypher query against a remote instance. | Show detailsHide details |
removeLabels() | Removes the given set of labels from the given node. | Show detailsHide details |
rollbackTransaction() | Marks the current transaction as failed and prevents all objects from being persisted in the database. | Show detailsHide details |
search() | Returns a collection of entities of the given type from the database, takes optional key/value pairs. Searches case-insensitive / inexact. | Show detailsHide details |
searchFulltext() | Returns a map of entities and search scores matching the given search string from the given fulltext index. | Show detailsHide details |
searchRelationshipsFulltext() | Returns a map of entities and search scores matching the given search string from the given fulltext index. Searches case-insensitve / inexact. | Show detailsHide details |
set() | Sets a value or multiple values on an entity. The values can be provided as a map or as a list of alternating keys and values. | Show detailsHide details |
setPrivileged() | Sets the given key/value pair(s) on the given entity with super-user privileges. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Database Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Conversion Functions
| Name | Description | |
|---|---|---|
bson() | Creates BSON document from a map / object. | Show detailsHide details |
coalesce() | Returns the first non-null value in the list of expressions passed to it. In case all arguments are null, null will be returned. | Show detailsHide details |
dateFormat() | Formats the given date object according to the given pattern, using the current locale (language/country settings). | Show detailsHide details |
escapeHtml() | Replaces HTML characters with their corresponding HTML entities. | Show detailsHide details |
escapeJavascript() | Escapes the given string for use with Javascript. | Show detailsHide details |
escapeJson() | Escapes the given string for use within JSON. | Show detailsHide details |
escapeXml() | Replaces XML characters with their corresponding XML entities. | Show detailsHide details |
formurlencode() | Encodes the given object to an application/x-www-form-urlencoded string. | Show detailsHide details |
hash() | Returns the hash (as a hexadecimal string) of a given string, using the given algorithm (if available via the underlying JVM). | Show detailsHide details |
int() | Tries to convert the given object into an integer value. | Show detailsHide details |
latLonToUtm() | Converts the given latitude/longitude coordinates into an UTM string. | Show detailsHide details |
long() | Tries to convert the given object into a long integer value. | Show detailsHide details |
md5() | Returns the MD5 hash of a given object. | Show detailsHide details |
num() | Tries the convert given object into a floating-point number with double precision. | Show detailsHide details |
numberFormat() | Formats the given value using the given locale and format string. | Show detailsHide details |
parseDate() | Parses the given date string using the given format string. | Show detailsHide details |
parseNumber() | Parses the given string using the given (optional) locale. | Show detailsHide details |
toDate() | Converts the given number to a date. | Show detailsHide details |
toGraphObject() | Converts the given entity to GraphObjectMap. | Show detailsHide details |
unescapeHtml() | Reverses the effect of escape_html(). | Show detailsHide details |
urlencode() | URL-encodes the given string. | Show detailsHide details |
utmToLatLon() | Converts the given UTM string to latitude/longitude coordinates. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Conversion Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
String Functions
| Name | Description | |
|---|---|---|
abbr() | Abbreviates the given string at the last space character before the maximum length is reached. | Show detailsHide details |
base64decode() | Decodes the given base64 text using the supplied scheme. | Show detailsHide details |
base64encode() | Encodes the given string and returns a base64-encoded string. | Show detailsHide details |
capitalize() | Capitalizes the given string. | Show detailsHide details |
clean() | Cleans the given string. | Show detailsHide details |
concat() | Concatenates the given list of objects into a single string without a separator between them. | Show detailsHide details |
contains() | Returns true if the given string or collection contains a given element. | Show detailsHide details |
endsWith() | Returns true if the given string ends with the given suffix. | Show detailsHide details |
indexOf() | Returns the position of the first occurrence of the given word in the given string, or -1 if the string doesn’t contain the word. | Show detailsHide details |
join() | Joins the given collection of strings into a single string, separated by the given separator. | Show detailsHide details |
length() | Returns the length of the given string. | Show detailsHide details |
localize() | Returns a (cached) Localization result for the given key and optional domain. | Show detailsHide details |
lower() | Returns the lowercase version of the given string. | Show detailsHide details |
replace() | Replaces script expressions in the given template with values from the given entity. | Show detailsHide details |
split() | Splits the given string by the whole separator string. | Show detailsHide details |
splitRegex() | Splits the given string by given regex. | Show detailsHide details |
startsWith() | Returns true if the given string starts with the given prefix. | Show detailsHide details |
stopWords() | Returns a list of words (for the given language) which can be ignored for NLP purposes. | Show detailsHide details |
strReplace() | Replaces each substring of the subject that matches the given regular expression with the given replacement. | Show detailsHide details |
stripHtml() | Removes all HTML tags from the given source string and returns only the content. | Show detailsHide details |
substring() | Returns the substring of the given string. | Show detailsHide details |
titleize() | Titleizes the given string. | Show detailsHide details |
trim() | Removes whitespace at the edges of the given string. | Show detailsHide details |
upper() | Returns the uppercase value of its parameter. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(String Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
System Functions
| Name | Description | |
|---|---|---|
changelog() | Returns the changelog for a given entity. | Show detailsHide details |
disableCascadingDelete() | Disables cascading delete in the Structr Backend for the current transaction. | Show detailsHide details |
disableNotifications() | Disables the Websocket broadcast notifications in the Structr Backend UI for the current transaction. | Show detailsHide details |
disableUuidValidation() | Disables the validation of user-supplied UUIDs when creating objects. | Show detailsHide details |
doAs() | Runs the given function in the context of the given user. | Show detailsHide details |
doInNewTransaction() | Runs the given function in a new transaction context. | Show detailsHide details |
doPrivileged() | Runs the given function in a privileged (superuser) context. | Show detailsHide details |
enableCascadingDelete() | Enables cascading delete in the Structr Backend for the current transaction. | Show detailsHide details |
enableNotifications() | Enables the Websocket broadcast notifications in the Structr Backend Ui for the current transaction. | Show detailsHide details |
evaluateScript() | Evaluates a serverside script string in the context of the given entity. | Show detailsHide details |
getAvailableServerlogs() | Returns a collection of available server logs files. | Show detailsHide details |
getCacheValue() | Retrieves the cached value for the given key. | Show detailsHide details |
getSessionAttribute() | Retrieve a value for the given key from the user session. | Show detailsHide details |
getenv() | Returns the value of the specified environment variable. If no value is specified, all environment variables are returned as a map. An environment variable is a system-dependent external named value. | Show detailsHide details |
hasCacheValue() | Checks if a cached value exists for the given key. | Show detailsHide details |
isLocale() | Returns true if the current user locale is equal to the given argument. | Show detailsHide details |
jobInfo() | Returns information about the job with the given job ID. | Show detailsHide details |
jobList() | Returns a list of running jobs. | Show detailsHide details |
logEvent() | Logs an event to the Structr log. | Show detailsHide details |
maintenance() | Allows an admin user to execute a maintenance command from within a scripting context. | Show detailsHide details |
random() | Returns a random alphanumeric string of the given length. | Show detailsHide details |
randomUuid() | Returns a new random UUID (v4). | Show detailsHide details |
removeSessionAttribute() | Remove key/value pair from the user session. | Show detailsHide details |
serverlog() | Returns the last n lines from the server log file. | Show detailsHide details |
setEncryptionKey() | Sets the secret key for encryt()/decrypt(), overriding the value from structr.conf. | Show detailsHide details |
setLogLevel() | Sets the application log level to the given level, if supported. | Show detailsHide details |
setSessionAttribute() | Store a value under the given key in the users session. | Show detailsHide details |
sleep() | Pauses the execution of the current thread for the given number of milliseconds. | Show detailsHide details |
stackDump() | Logs the current execution stack. | Show detailsHide details |
store() | Stores the given value in the current request context under the given key. | Show detailsHide details |
structrEnv() | Returns Structr runtime env information. | Show detailsHide details |
systemInfo() | Returns information about the system. | Show detailsHide details |
timer() | Controls a named timer by starting, pausing, clearing, or returning its current elapsed time in milliseconds. | Show detailsHide details |
userChangelog() | Returns the changelog for the changes a specific user made. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(System Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Mathematical Functions
| Name | Description | |
|---|---|---|
add() | Returns the sum of the given arguments. | Show detailsHide details |
ceil() | Returns the given value, rounded up to the nearest integer. | Show detailsHide details |
div() | Returns the result of value1 divided by value2. | Show detailsHide details |
floor() | Returns the given value, rounded down to the nearest integer. | Show detailsHide details |
max() | Returns the greater of the given values. | Show detailsHide details |
min() | Returns the smaller of the given values. | Show detailsHide details |
mod() | Implements the modulo operation on two integer values. | Show detailsHide details |
mult() | Returns the product of all given arguments. | Show detailsHide details |
quot() | Divides the first argument by the second argument. | Show detailsHide details |
rint() | Returns a random integer in the given range. | Show detailsHide details |
round() | Rounds the given argument to the nearest integer. | Show detailsHide details |
subt() | Subtracts the second argument from the first argument. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Mathematical Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Access Control Functions
| Name | Description | |
|---|---|---|
addToGroup() | Adds the given user as a member of the given group. | Show detailsHide details |
copyPermissions() | Copies the security configuration of an entity to another entity. | Show detailsHide details |
grant() | Grants the given permissions on the given node to the given principal. | Show detailsHide details |
isAllowed() | Returns true if the given principal has the given permissions on the given node. | Show detailsHide details |
isInGroup() | Returns true if the given user is in the given group. | Show detailsHide details |
removeFromGroup() | Removes the given user from the given group. | Show detailsHide details |
revoke() | Revokes the given permissions on the given entity from a user. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Access Control Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Scripting Functions
| Name | Description | |
|---|---|---|
applicationStoreDelete() | Removes a stored value from the application level store. | Show detailsHide details |
applicationStoreGet() | Returns a stored value from the application level store. | Show detailsHide details |
applicationStoreGetKeys() | Lists all keys stored in the application level store. | Show detailsHide details |
applicationStoreHas() | Checks if a key is present in the application level store. | Show detailsHide details |
applicationStorePut() | Stores a value in the application level store. | Show detailsHide details |
call() | Calls the given user-defined function in the current users context. | Show detailsHide details |
callPrivileged() | Calls the given user-defined function in a superuser context. | Show detailsHide details |
coalesceObjects() | Returns the first non-null value in the list of expressions passed to it. In case all arguments are null, null will be returned. | Show detailsHide details |
mergeProperties() | Copies the values for the given list of property keys from the source entity to the target entity. | Show detailsHide details |
requestStoreDelete() | Removes a stored value from the request level store. | Show detailsHide details |
requestStoreGet() | Retrieves a stored value from the request level store. | Show detailsHide details |
requestStoreGetKeys() | Lists all keys stored in the request level store. | Show detailsHide details |
requestStoreHas() | Checks if a key is present in the request level store. | Show detailsHide details |
requestStorePut() | Stores a value in the request level store. | Show detailsHide details |
retrieve() | Returns the value associated with the given key from the temporary store. | Show detailsHide details |
schedule() | Schedules a script or a function to be executed in a separate thread. | Show detailsHide details |
weekDays() | Calculates the number of week days (working days) between given dates. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Scripting Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Logic Functions
| Name | Description | |
|---|---|---|
and() | Returns the logical AND result of the given boolean expressions. | Show detailsHide details |
empty() | Returns a boolean value that indicates whether the given object is null or empty. | Show detailsHide details |
equal() | Returns a boolean value that indicates whether the values are equal. | Show detailsHide details |
gt() | Returns true if the first argument is greater than the second argument. | Show detailsHide details |
gte() | Returns true if the first argument is greater than or equal to the second argument. | Show detailsHide details |
lt() | Returns true if the first argument is less than the second argument. | Show detailsHide details |
lte() | Returns true if the first argument is less that or equal to the second argument. | Show detailsHide details |
not() | Returns the logical negation given boolean expression. | Show detailsHide details |
one() | Checks if a number is equal to 1, returns the oneValue if yes, the otherValue if no. | Show detailsHide details |
or() | Returns the logical OR result of the given boolean expressions. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Logic Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Collection Functions
| Name | Description | |
|---|---|---|
complement() | Removes objects from a list. | Show detailsHide details |
doubleSum() | Returns the sum of all the values in the given collection as a floating-point value. | Show detailsHide details |
extract() | Extracts property values from all elements of a collection and returns them as a collection. | Show detailsHide details |
first() | Returns the first element of the given collection. | Show detailsHide details |
intSum() | Returns the sum of the given arguments as an integer. | Show detailsHide details |
isCollection() | Returns true if the given argument is a collection. | Show detailsHide details |
last() | Returns the last element of the given collection. | Show detailsHide details |
merge() | Merges collections and objects into a single collection. | Show detailsHide details |
mergeUnique() | Merges collections and objects into a single collection, removing duplicates. | Show detailsHide details |
nth() | Returns the element with the given index of the given collection. | Show detailsHide details |
size() | Returns the size of the given collection. | Show detailsHide details |
sort() | Sorts the given collection or array according to the given property key. Default sort key is ‘name’. | Show detailsHide details |
unwind() | Converts a list of lists into a flat list. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Collection Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Rendering Functions
| Name | Description | |
|---|---|---|
component() | Finds and returns the component with the given name in the current page. | Show detailsHide details |
getSource() | Returns the rendered HTML content for the given element. | Show detailsHide details |
hasCssClass() | Returns whether the given element has the given CSS class(es). | Show detailsHide details |
include() | Loads the element with the given name and renders its HTML representation into the output buffer. | Show detailsHide details |
includeChild() | Loads a template’s child element with the given name and renders its HTML representation into the output buffer. | Show detailsHide details |
insertHtml() | Inserts a new HTML subtree into the DOM. | Show detailsHide details |
print() | Prints the given strings or objects to the output buffer. | Show detailsHide details |
removeDomChild() | Removes a node from the DOM. | Show detailsHide details |
render() | Renders the children of the current node. | Show detailsHide details |
renderEach() | Renders the filtered contents of a component’s enclosing data source according to the data adapter configuration. | Show detailsHide details |
renderFields() | Renders values for one or all of the fields of one element from the enclosing component’s data source, wrapped in the given tag. | Show detailsHide details |
renderLabels() | Renders labels for one or all of the fields of one element from the enclosing component’s data source, wrapped in the given tag. | Show detailsHide details |
replaceDomChild() | Replaces a node from the DOM with new HTML. | Show detailsHide details |
setDetailsObject() | Allows overriding the current keyword with a given entity. | Show detailsHide details |
setLocale() | Sets the locale for the current request. | Show detailsHide details |
template() | Returns a MailTemplate object with the given name, replaces the placeholders with values from the given entity. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Rendering Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Miscellaneous Functions
| Name | Description | |
|---|---|---|
dateAdd() | Adds the given values to a date. | Show detailsHide details |
invalidateCacheValue() | Invalidates the cached value for the given key (if present). | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Miscellaneous Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Input Output Functions
| Name | Description | |
|---|---|---|
append() | Appends text to a file in the exchange/ folder. | Show detailsHide details |
appendContent() | Appends content to a Structr File. | Show detailsHide details |
barcode() | Creates a barcode image of given type with the given data. | Show detailsHide details |
config() | Returns the configuration value associated with the given key from structr.conf. | Show detailsHide details |
copyFileContents() | Copies the content of sourceFile to targetFile and updates the meta-data accordingly. | Show detailsHide details |
createArchive() | Creates and returns a ZIP archive with the given files (and folders). | Show detailsHide details |
createFolderPath() | Creates a new folder in the virtual file system including all parent folders if they don’t exist already. | Show detailsHide details |
createZip() | Creates and returns a ZIP archive with the given files (and folders). | Show detailsHide details |
decrypt() | Decrypts a base 64 encoded AES ciphertext and returns the decrypted result. | Show detailsHide details |
encrypt() | Encrypts the given string using AES and returns the ciphertext encoded in base 64. | Show detailsHide details |
exec() | Executes a script returning the standard output of the script. | Show detailsHide details |
execBinary() | Executes a script returning the returning the raw output directly into the output stream. | Show detailsHide details |
flow() | Executes a given Flow and returns the evaluation result. | Show detailsHide details |
fromCsv() | Parses the given CSV string and returns a list of objects. | Show detailsHide details |
fromExcel() | Reads data from a given Excel sheet. | Show detailsHide details |
fromJson() | Parses the given JSON string and returns an object. | Show detailsHide details |
fromXml() | Parses the given XML and returns a JSON string. | Show detailsHide details |
getContent() | Returns the content of the given file. | Show detailsHide details |
getCsvHeaders() | Parses the given CSV string and returns a list of column headers. | Show detailsHide details |
importCss() | Imports CSS classes, media queries etc. from given CSS file. | Show detailsHide details |
importGpx() | Parses a given GPX string and returns its contents as an object with. | Show detailsHide details |
importHtml() | Imports HTML source code into an element. | Show detailsHide details |
log() | Logs the given objects to the logfile. | Show detailsHide details |
pdf() | Creates the PDF representation of a given page. | Show detailsHide details |
read() | Reads text from a file in the exchange/ folder. | Show detailsHide details |
setContent() | Sets the content of the given file. Content can either be of type String or byte[]. | Show detailsHide details |
toCsv() | Returns a CSV representation of the given nodes. | Show detailsHide details |
toExcel() | Creates Excel from given data. | Show detailsHide details |
toJson() | Serializes the given object to JSON. | Show detailsHide details |
translate() | Translates the given string from the source language to the target language. | Show detailsHide details |
unarchive() | Unarchives given file to an optional parent folder. | Show detailsHide details |
write() | Writes text to a new file in the exchange/ folder. | Show detailsHide details |
xml() | Tries to parse the contents of the given string into an XML document, returning the document on success. | Show detailsHide details |
xpath() | Returns the value of the given XPath expression from the given XML document. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Input Output Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Security Functions
| Name | Description | |
|---|---|---|
confirmationKey() | Creates a confirmation key to use as a one-time token. Used for user confirmation or password reset. | Show detailsHide details |
createAccessAndRefreshToken() | Creates both JWT access token and refresh token for the given User entity that can be used for request authentication and authorization. | Show detailsHide details |
createAccessToken() | Creates a JWT access token for the given user entity that can be used for request authentication and authorization. | Show detailsHide details |
hmac() | Returns a keyed-hash message authentication code generated out of the given payload, secret and hash algorithm. | Show detailsHide details |
login() | Logs the given user in. With two arguments, verifies the password first. With one argument (user only), requires a privileged context (doPrivileged). | Show detailsHide details |
pdfEncrypt() | Encrypts a PDF file so that it can’t be opened without password. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Security Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Validation Functions
| Name | Description | |
|---|---|---|
assert() | Aborts the current request if the given condition evaluates to false. | Show detailsHide details |
clearError() | Clears the given error token from the current context. | Show detailsHide details |
clearErrors() | Clears all error tokens present in the current context. | Show detailsHide details |
error() | Stores error tokens in the current context causing the transaction to fail at the end of the request. | Show detailsHide details |
getErrors() | Returns all error tokens present in the current context. | Show detailsHide details |
hasError() | Allows checking if an error has been raised in the scripting context. | Show detailsHide details |
isValidEmail() | Checks if the given address is a valid email address. | Show detailsHide details |
isValidUuid() | Tests if a given string is a valid UUID. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Validation Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
theme()
| Name | Description |
|---|
Markdown Rendering Hint: Children of Function(theme()) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
EMail Functions
| Name | Description | |
|---|---|---|
mailAddAttachment() | Adds an attachment with an optional file name to the current mail. | Show detailsHide details |
mailAddBcc() | Adds a Bcc: recipient to the current mail. | Show detailsHide details |
mailAddCc() | Adds a Cc: recipient to the current mail. | Show detailsHide details |
mailAddHeader() | Adds a custom header to the current mail. | Show detailsHide details |
mailAddMimePart() | Adds a MIME part to the current mail. | Show detailsHide details |
mailAddReplyTo() | Adds a Reply-To: recipient to the current mail. | Show detailsHide details |
mailAddTo() | Adds a To: recipient to the current mail. | Show detailsHide details |
mailBegin() | Begins a new mail configuration. | Show detailsHide details |
mailClearAttachments() | Removes all attachments from the current mail. | Show detailsHide details |
mailClearBcc() | Clears the current list of Bcc: recipients. | Show detailsHide details |
mailClearBounceAddress() | Removes the bounce address from the current mail. | Show detailsHide details |
mailClearCc() | Clears the current list of Cc: recipients. | Show detailsHide details |
mailClearHeaders() | Clears any configured custom headers for the current mail. | Show detailsHide details |
mailClearInReplyTo() | Removes the In-Reply-To header from the current mail. | Show detailsHide details |
mailClearMimeParts() | Removes all custom MIME parts from the current mail. | Show detailsHide details |
mailClearReplyTo() | Removes all Reply-To: configuration from the current mail. | Show detailsHide details |
mailClearTo() | Clears the current list of To: recipients. | Show detailsHide details |
mailDecodeText() | Decodes RFC 822 “text” token from mail-safe form as per RFC 2047. | Show detailsHide details |
mailEncodeText() | Encodes RFC 822 “text” token into mail-safe form as per RFC 2047. | Show detailsHide details |
mailGetError() | Returns the last error message (or null if no error has occurred). | Show detailsHide details |
mailGetLastOutgoingMessage() | Returns the last outgoing message sent by the advanced mail module in the current script as a node of type EMailMessage. | Show detailsHide details |
mailHasError() | Returns true if an error occurred while sending the mail. | Show detailsHide details |
mailRemoveHeader() | Removes a specific custom header from the current mail. | Show detailsHide details |
mailResetManualConfig() | Resets a manual SMTP configuration for the current mail. | Show detailsHide details |
mailSaveOutgoingMessage() | Configures if the current mail should be saved or not. | Show detailsHide details |
mailSelectConfig() | Selects a configuration prefix for the SMTP configuration. | Show detailsHide details |
mailSend() | Sends the currently configured mail. | Show detailsHide details |
mailSetBounceAddress() | Sets the bounce address of the current mail. | Show detailsHide details |
mailSetFrom() | Overwrites/Sets the from address (and optionally name) of the current mail. | Show detailsHide details |
mailSetHtmlContent() | Overwrites/Sets the HTML content of the current mail. | Show detailsHide details |
mailSetInReplyTo() | Sets the In-Reply-To header for the outgoing mail. | Show detailsHide details |
mailSetManualConfig() | Sets a manual SMTP configuration for the current mail. | Show detailsHide details |
mailSetSubject() | Overwrites/Sets the subject of the current mail. | Show detailsHide details |
mailSetTextContent() | Sets/Overwrites the text content of the current mail. | Show detailsHide details |
sendHtmlMail() | Sends an HTML email. | Show detailsHide details |
sendPlaintextMail() | Sends a plaintext email. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(EMail Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Http Functions
| Name | Description | |
|---|---|---|
DELETE() | Sends an HTTP DELETE request with an optional content type to the given URL and returns the response headers and body. | Show detailsHide details |
GET() | Sends an HTTP GET request to the given URL and returns the response headers and body. | Show detailsHide details |
HEAD() | Sends an HTTP HEAD request with optional username and password to the given URL and returns the response headers. | Show detailsHide details |
PATCH() | Sends an HTTP PATCH request to the given URL and returns the response headers and body. | Show detailsHide details |
POST() | Sends an HTTP POST request to the given URL and returns the response body. | Show detailsHide details |
POSTMultiPart() | Sends a multi-part HTTP POST request to the given URL and returns the response body. | Show detailsHide details |
PUT() | Sends an HTTP PUT request with an optional content type to the given URL and returns the response headers and body. | Show detailsHide details |
addHeader() | Temporarily adds the given (key, value) tuple to the local list of request headers. | Show detailsHide details |
clearHeaders() | Clears headers for the next HTTP request. | Show detailsHide details |
fetch() | Sends an HTTP request with an arbitrary method to the given URL and returns the response headers, body, and status code. | Show detailsHide details |
getCookie() | Returns the requested cookie if it exists. | Show detailsHide details |
getRequestHeader() | Returns the value of the given request header field. | Show detailsHide details |
getRequestHeaderNames() | Returns a collection of all the header names the current request contains. | Show detailsHide details |
removeResponseHeader() | Removes the given header field from the server response. | Show detailsHide details |
setCookie() | Sets the given cookie. | Show detailsHide details |
setResponseCode() | Sets the response code of the current rendering run. | Show detailsHide details |
setResponseHeader() | Adds the given header field and value to the response of the current rendering run. | Show detailsHide details |
validateCertificates() | Disables or enables strict certificate checking when performing a request in a scripting context. The setting remains for the whole request. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Http Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
MQTT Functions
| Name | Description | |
|---|---|---|
mqttPublish() | Publishes message on given mqtt client with given topic. | Show detailsHide details |
mqttSubscribe() | Subscribes given topic on given mqtt client. | Show detailsHide details |
mqttUnsubscribe() | Unsubscribes given topic on given mqtt client. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(MQTT Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Geocoding Functions
| Name | Description | |
|---|---|---|
azimuth() | Returns the azimuth between two geometries. | Show detailsHide details |
convertGeometry() | Converts the given geometry from source CRS to destination CRS. | Show detailsHide details |
coordsToLineString() | Converts a coordinate array into a line string geometry. | Show detailsHide details |
coordsToMultipoint() | Converts a coordinate array into a multipoint geometry. | Show detailsHide details |
coordsToPoint() | Converts a coordinate into a point. | Show detailsHide details |
coordsToPolygon() | Converts a coordinate array into a polygon. | Show detailsHide details |
distance() | Returns the distance between two geometries. | Show detailsHide details |
geocode() | Returns the geolocation (latitude, longitude) for the given street address using the configured geocoding provider. | Show detailsHide details |
getCoordinates() | Returns the coordinates of a geometry. | Show detailsHide details |
getWcsData() | Reads coverage data from a WCS endpoint and returns it. | Show detailsHide details |
getWcsHistogram() | Reads coverage data from a WCS endpoint and returns it. | Show detailsHide details |
getWfsData() | Reads features from a WFS endpoint and returns geometries. | Show detailsHide details |
lineSegment() | Returns a line segment with start point, azimuth and length. | Show detailsHide details |
lineStringsToPolygons() | Merges line strings to polygons. | Show detailsHide details |
makePolygonValid() | Makes a polygon valid. | Show detailsHide details |
readShapefile() | Reads a shapefile from a Structr path and returns it as a list of WKT strings. | Show detailsHide details |
wktToGeometry() | Converts a WKT string into a geometry object. | Show detailsHide details |
wktToPolygons() | Converts a WKT string into a list of polygons. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Geocoding Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Schema Functions
| Name | Description | |
|---|---|---|
ancestorTypes() | Returns the list of parent types of the given type including the type itself. | Show detailsHide details |
enumInfo() | Returns the possible values of an enum property. | Show detailsHide details |
functionInfo() | Returns information about the currently running Structr method, or about the method defined in the given type and name. | Show detailsHide details |
getRelationshipTypes() | Returns the list of available relationship types form and/or to this node. Either potentially available (schema) or actually available (database). | Show detailsHide details |
inheritingTypes() | Returns the list of subtypes of the given type including the type itself. | Show detailsHide details |
propertyInfo() | Returns the schema information for the given property. | Show detailsHide details |
typeInfo() | Returns the type information for the specified type. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Schema Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Predicate Functions
| Name | Description | |
|---|---|---|
predicate.and | Combines the given predicates using logical AND, returning a predicate usable with find() or search(). | Show detailsHide details |
predicate.any | Returns a query predicate that can be used with find() and search(). | Show detailsHide details |
predicate.contains | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.empty | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.endsWith | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.equals | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.gt | Returns a gt predicate that can be used in find() function calls. | Show detailsHide details |
predicate.gte | Returns a gte predicate that can be used in find() function calls. | Show detailsHide details |
predicate.lt | Returns an lt predicate that can be used in find() function calls. | Show detailsHide details |
predicate.lte | Returns an lte predicate that can be used in find() function calls. | Show detailsHide details |
predicate.not | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.or | Combines the given predicates using logical OR, returning a predicate usable with find() or search(). | Show detailsHide details |
predicate.page | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.range | Returns a range predicate that can be used in find() function calls. | Show detailsHide details |
predicate.sort | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.startsWith | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
predicate.withinDistance | Returns a query predicate that can be used with find() or search(). | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Predicate Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Miscellaneous functions
| Name | Description | |
|---|---|---|
cache() | Stores a value in the global cache. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Miscellaneous functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Logic functions
| Name | Description | |
|---|---|---|
if() | Evaluates a condition and executes different expressions depending on the result. | |
is() | Evaluates a condition and executes an expressions if the result is true. |
Markdown Rendering Hint: Children of Topic(Logic functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.
Collection functions
| Name | Description | |
|---|---|---|
all() | Evaluates a StructrScript expression for every element of a collection and returns true if the expression evaluates to true for all of the elements. | Show detailsHide details |
any() | Evaluates a StructrScript expression for every element of a collection and returns true if the expression evaluates to true for any of the elements. | Show detailsHide details |
each() | Evaluates a StructrScript expression for every element of a collection. | Show detailsHide details |
filter() | Filters a list using a StructrScript expression. | Show detailsHide details |
map() | Returns a single result from all elements of a list by applying a reduction function. | Show detailsHide details |
none() | Evaluates a StructrScript expression for every element of a collection and returns true if the expression evaluates to true for none of the elements. | Show detailsHide details |
Markdown Rendering Hint: Children of Topic(Collection functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.