Primitive type

NULL

Declaration name

null

Return value of6

current_user(PHP function)

current_user_account(PHP function)

current_user_name(PHP function)

Extractor::si(PHP static method)

Matcher::lookup(PHP static method)

Tobject::_get(PHP static method)

Type of31

Parameter
Coding name	value
Position	3
Type	Topic reference(Custom type) Tobject(PHP class)
Parameter of	html_select(PHP function)

Parameter
Coding name	filename
Description	Optionally pass a file to archive in Topincs. Only valid for topic types subtyping Topincs file.
Position	2
Type	String(Primitive type)
Parameter of	Tobject::make(PHP static method)

Parameter
Coding name	orignal_name
Description	Optionally provide an alternative original name for a file (other than the one used in the file system).
Position	3
Type	String(Primitive type)
Parameter of	Tobject::make(PHP static method)

Parameter
Coding name	encoding
Description	Optionally pass an encoding for files holding characters.
Position	4
Type	String(Primitive type)
Parameter of	Tobject::make(PHP static method)

Parameter
Coding name	extension
Description	The extension of the format. Must be given only, when the service has more than one extension.
Position	1
Type	String(Primitive type)
Parameter of	ServiceCall->get(PHP instance method)
Default value	No extension given.
Comments	Since a service might gain a format in the future, you should pass it, if you want to be on the safe side.
Examples	txt csv html

Parameter
Coding name	extension
Position	1
Type	String(Primitive type)
Parameter of	ServiceCall->post(PHP instance method)
Default value	No extension, so null. Most services only have one representation.
Examples	txt json

Parameter
Coding name	when
Description	When the service call should be executed. Might be in the past, but the earliest time the call is actually processed is after the current request has finished.
Position	1
Type	DateTime(Primitive type) DateInterval(Primitive type)
Parameter of	ServiceCall->schedule(PHP instance method)
Default value	Now
Examples	[%new DateInterval("PT3S")%] [%new DateTime("2030-12-31")%]

Parameter
Coding name	valid_until
Position	2
Type	DateTime(Primitive type) DateInterval(Primitive type)
Parameter of	ticket(PHP function)
Default value	7 days.
Comments	A %DateInterval% is added to now. It is the maximum lifetime of the ticket. If a ticket already exists that expires a sixth earlier than demanded, it suffices and will be resused. So for a year, that is approximately two months. No tolerance is applied to a %DateTime%. It must be valid to exactly that date.
See also	www.topincs.com/issues/9619

Parameter
Coding name	string
Description	The string to be converted.
Position	1
Type	String(Primitive type)
Parameter of	convert(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	id
Description	The id of the element.
Position	3
Type	String(Primitive type)
Parameter of	select_char(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	tag
Description	The tag of the child elements representing the individual characters.
Position	4
Type	String(Primitive type)
Parameter of	select_char(PHP function)
Default value	span
Introduced in	Topincs 9.0.0

Parameter
Coding name	range
Description	The range of the characters.
Position	5
Type	Array(Primitive type)
Parameter of	select_char(PHP function)
Default value	From A-Z.
Introduced in	Topincs 9.0.0

Parameter
Coding name	nodes
Description	A selector
Position	7
Type	CSS Selector(Custom type)
Parameter of	select_char(PHP function)
Default value	null
Introduced in	Topincs 9.0.0

Parameter
Coding name	html
Description	The message in HTML format.
Position	6
Type	String(Primitive type)
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	cc
Position	8
Type	Email address(Custom type) Array(Primitive type)
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	bcc
Position	9
Type	Email address(Custom type) Array(Primitive type)
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	attachment
Position	10
Type	Absolute filepath(Custom type) File tobject(Custom type) Array(Primitive type)
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	image
Position	11
Type	Absolute filepath(Custom type) File tobject(Custom type) Array(Primitive type)
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	total
Description	The total. If given progress will be interpreted as a counter to total.
Position	2
Type	Integer(Primitive type)
Parameter of	progress(PHP function)
Default value	No total.
Comments	Relieves the caller from calculating the progress.

Parameter
Coding name	sort
Description	The index of the column the table is sorted by. This will mark the arrows in the header accordingly.
Position	8
Type	String(Primitive type)
Parameter of	table(PHP function)
Default value	null. None of columns will be initially marked sorted in the header.
Comments	Put a minus in front of an index to mark the upwards arrow. If there is more than one column sorted, use SPACE to separate the indices, e.g. "-2 1".

Parameter
Coding name	sortable
Description	Whether the table is sortable. If false, individual columns can be declared sortable.
Position	9
Type	Boolean(Primitive type)
Parameter of	table(PHP function)
Default value	false. The table is not sortable.

Parameter
Coding name	id
Description	The id of the table.
Position	10
Type	String(Primitive type)
Parameter of	table(PHP function)
Comments	Only supported if format is %html%.

Parameter
Coding name	lang
Description	The two letter ISO code, e.g. en, fr, de.
Position	1
Type	String(Primitive type)
Parameter of	lang(PHP function)

Parameter
Coding name	when
Description	When the service should be executed. When float/int is given, it is in seconds from the time of the call, with a significant sub second part behind the comma.
Position	3
Type	DateInterval(Primitive type) DateTime(Primitive type) Float(Primitive type)
Parameter of	schedule(PHP function)
Default value	Now.

Parameter
Coding name	description
Description	The value of og:description meta tag.
Position	1
Type	String(Primitive type)
Parameter of	html_meta(PHP function)
Default value	NULL, meaning no meta tag og:description is rendered.
Comments	The value is trimmed and stripped of tags.

Parameter
Coding name	image
Description	The URL of an image to be used as the value of the og:image meta tag in the HTML.
Position	2
Type	String(Primitive type)
Parameter of	html_meta(PHP function)
Default value	NULL, meaning the tag will be omitted.

Parameter
Coding name	title
Description	The value of the og:title meta tag.
Position	3
Type	String(Primitive type)
Parameter of	html_meta(PHP function)
Default value	The name of the service, when not overridden by html_title.

Parameter
Coding name	contents
Description	The contents of the file.
Position	1
Type	String(Primitive type)
Parameter of	tmp_file(PHP function)
Default value	The file is created empty.

Parameter
Coding name	type
Description	The type of the website.
Position	4
Type	String(Primitive type)
Parameter of	html_meta(PHP function)
Default value	website

Parameter
Coding name	in
Position	1
Type	Array(Primitive type) Topic reference(Custom type)
Parameter of	user(PHP function)

Parameter
Coding name	not_in
Position	2
Type	Array(Primitive type) Topic reference(Custom type)
Parameter of	user(PHP function)

See also

www.php.net/…al/en/language.types.null.php

Saving …

Before we continue …

No internet connection