Type of41
Parameter |
Coding name |
sernames
|
Description |
An array of sernames if only a subset should be converted to query string.
|
Position |
1
|
Parameter of |
Tobject->to_query_string(PHP instance method)
|
Default value |
All sernames, meaning all statements are included.
|
Introduced in |
Topincs 7.8.0
|
Parameter |
Coding name |
value
|
Description |
The value to set.
|
Position |
2
|
Type |
Mixed(Primitive type)
|
Parameter of |
ImportSubject->set(PHP instance method)
|
Parameter |
Coding name |
value
|
Description |
The value to set. Must match the datatype.
|
Position |
2
|
Type |
Mixed(Primitive type)
|
Parameter of |
ImportSubject->replace(PHP instance method)
|
Parameter |
Coding name |
import_subjects
|
Description |
The extraction result.
|
Position |
1
|
Parameter of |
Importer::import(PHP static method)
|
Parameter |
Coding name |
results
|
Description |
An array to put result in natural langue.
|
Position |
2
|
Parameter of |
Importer::import(PHP static method)
|
Parameter |
Coding name |
errors
|
Description |
An array to store error messages.
|
Position |
3
|
Parameter of |
Importer::import(PHP static method)
|
Parameter |
Coding name |
options
|
Description |
An array of options.
|
Position |
4
|
Parameter of |
Importer::import(PHP static method)
|
Default value |
["duplicates" => "ignore", "machters" => []]
|
Comments |
The option %duplicates% determines how duplicates are treated:
* %ignore% means none of the attached statements will be imported.
* %error% means an error message is added to the errors array.
* %update% means the information in the store will be updated.
|
Parameter |
Coding name |
sernames
|
Description |
An array holding the sernames to copy.
|
Position |
1
|
Parameter of |
Tobject->copy(PHP instance method)
|
Default value |
Null, meaning all sernames. All statements will be copied.
|
Introduced in |
Topincs 8.4.0
|
Parameter |
Coding name |
row
|
Position |
1
|
Parameter of |
DataTable->add(PHP instance method)
|
Parameter |
Coding name |
columns
|
Description |
An array of associative arrays. Each entry must have a key 'name' and may have a key 'format'.
|
Position |
2
|
Parameter of |
CsvWriter::write(PHP static method)
|
Parameter |
Coding name |
options
|
Position |
3
|
Parameter of |
CsvWriter::write(PHP static method)
|
Parameter |
Coding name |
data
|
Description |
An associative array of property names to property values.
|
Position |
1
|
Parameter of |
Matcher::match(PHP static method)
|
Parameter |
Coding name |
data
|
Position |
1
|
Parameter of |
Matcher::lookup(PHP static method)
|
Option |
Option map |
table data
|
Coding name |
rows
|
Mandatory |
1
|
Array accepted |
0
|
Description |
An array holding zero or more untyped objects.
|
Option |
Option map |
table data
|
Coding name |
columns
|
Mandatory |
1
|
Array accepted |
0
|
Parameter |
Coding name |
rows
|
Position |
1
|
Parameter of |
sort_objects(PHP function)
|
Parameter |
Coding name |
context
|
Position |
2
|
Parameter of |
twig(PHP function)
|
Default value |
An empty array.
|
Parameter |
Coding name |
names
|
Description |
The list of names, an array of strings.
|
Position |
1
|
Parameter of |
select_char(PHP function)
|
Comments |
No need to make it unique, the function does that.
|
Option |
Option map |
options
|
Coding name |
range
|
Mandatory |
0
|
Array accepted |
0
|
Description |
The complete list of characters, active and inactive. Defaults to A-Z.
|
Parameter |
Coding name |
parameters
|
Description |
The parameters of the service call. A hash map from the formal name of the service argument to the value of the parameters.
|
Position |
2
|
Parameter of |
ServiceCall->__construct(PHP instance method)
|
Comments |
A single parameter value does not have to be put into an array, even if the maximum cardinality of the service argument is larger than 1.
|
Parameter |
Coding name |
actions
|
Description |
An associative array from URLs relative to the store URL to labels which will be rendered as buttons.
|
Position |
4
|
Parameter of |
StateException->__construct(PHP instance method)
|
Default value |
There will be two buttons: one to go back (like Browser back) and one to go to the start page.
|
Parameter |
Coding name |
converter
|
Description |
The name of function to convert the data. It is passed the string and returns a PHP native type, e.g. DateTime or boolean.
|
Position |
2
|
Type |
String(Primitive type)
|
Parameter of |
DataRow->mand(PHP instance method)
|
Comments |
Any number of converters can be passed as an array, they are applied in sequence until one return a non-null value.
|
Parameter |
Coding name |
range
|
Description |
The range of the characters.
|
Position |
5
|
Type |
NULL(Primitive type)
|
Parameter of |
select_char(PHP function)
|
Default value |
From A-Z.
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
to
|
Description |
The recipients.
|
Position |
7
|
Type |
Email address(Custom type)
|
Parameter of |
email(PHP function)
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
cc
|
Position |
8
|
Type |
|
Parameter of |
email(PHP function)
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
bcc
|
Position |
9
|
Type |
|
Parameter of |
email(PHP function)
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
attachment
|
Position |
10
|
Type |
|
Parameter of |
email(PHP function)
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
image
|
Position |
11
|
Type |
|
Parameter of |
email(PHP function)
|
Introduced in |
Topincs 9.0.0
|
Parameter |
Coding name |
rows
|
Description |
An array holding of stdClass objects (= a hash map in object form).
|
Position |
2
|
Parameter of |
table(PHP function)
|
Parameter |
Coding name |
columns
|
Description |
An array of strings, the column names. If datatype or format needs to be specified, an stdClass object with a mandatory name and optionally datatype, format, sortable.
|
Position |
3
|
Parameter of |
table(PHP function)
|
Parameter |
Coding name |
headers
|
Description |
Headers to send with the request.
|
Position |
4
|
Parameter of |
fetch(PHP function)
|
Default value |
The empty array, so no headers are sent.
|
Parameter |
Coding name |
parameters
|
Description |
The parameters to pass to the service.
|
Position |
2
|
Parameter of |
schedule(PHP function)
|
Default value |
The empty array.
|
Parameter |
Coding name |
parameters
|
Description |
The parameters to pass to the service.
|
Position |
2
|
Parameter of |
call(PHP function)
|
Default value |
The empty array.
|
Parameter |
Coding name |
parameters
|
Description |
The parameters to pass to the service.
|
Position |
2
|
Parameter of |
href(PHP function)
|
Default value |
The empty array.
|
Parameter |
Coding name |
context
|
Position |
2
|
Parameter of |
php(PHP function)
|
Default value |
An empty array.
|
Parameter |
Coding name |
tags
|
Description |
An array of key value pairs of additional meta headers
|
Position |
5
|
Parameter of |
html_meta(PHP function)
|
Parameter |
Coding name |
filter
|
Description |
One or more computation rules.
|
Position |
1
|
Parameter of |
Tobject::all(PHP static method)
|
Parameter |
Coding name |
inline
|
Position |
11
|
Type |
String(Primitive type)
|
Parameter of |
email(PHP function)
|
Parameter |
Coding name |
in
|
Position |
1
|
Type |
|
Parameter of |
user(PHP function)
|
Parameter |
Coding name |
not_in
|
Position |
2
|
Type |
|
Parameter of |
user(PHP function)
|
Parameter |
Coding name |
options
|
Description |
Additional options for CURL.
|
Position |
10
|
Parameter of |
fetch(PHP function)
|
|