String

Declaration name

string

Return value of34

call(PHP function)

consonants(PHP function)

CsvWriter::write(PHP static method)

current_url(PHP function)

current_user_name(PHP function)

Extractor::si(PHP static method)

fetch(PHP function)

filename_str(PHP function)

format(PHP function)

href(PHP function)

html_select(PHP function)

inline_css(PHP function)

letters(PHP function)

pdf(PHP function)

php(PHP function)

random_str(PHP function)

select_char(PHP function)

sequence(PHP function)

ServiceCall->get(PHP instance method)

ServiceCall->href(PHP instance method)

ServiceParameters->get_unparsed(PHP instance method)

table(PHP function)

ticket(PHP function)

tmp_dir(PHP function)

Tobject->a(PHP instance method)

Tobject->label(PHP instance method)

Tobject->ocr(PHP instance method)

Tobject->thumb(PHP instance method)

Tobject->to_query_string(PHP instance method)

Tobject->type(PHP instance method)

TopincsSequence->last_value(PHP instance method)

twig(PHP function)

txt(PHP function)

url(PHP function)

Type of100

Parameter
Coding name	class_name
Position	1
Parameter of	Tobject::register(PHP static method)

Parameter
Coding name	name
Position	1
Parameter of	ServiceParameters->get_unparsed(PHP instance method)

Parameter
Coding name	name
Position	1
Parameter of	ServiceParameters->get_all_unparsed(PHP instance method)

Parameter
Coding name	name
Position	1
Parameter of	ServiceParameters->get(PHP instance method)

Parameter
Coding name	name
Position	1
Parameter of	ServiceParameters->get_all(PHP instance method)

Parameter
Coding name	tt
Description	A serialization name of a topic type.
Position	1
Parameter of	Tobject::accelerate(PHP static method)

Parameter
Coding name	st
Position	2
Parameter of	Tobject::accelerate(PHP static method)

Parameter
Coding name	username
Description	The login name of the user.
Position	1
Parameter of	TopincsUserAccount::create(PHP static method)

Parameter
Coding name	email
Description	The email address used to manage this user account. Can be used for resetting the password or recovering the username.
Position	3
Parameter of	TopincsUserAccount::create(PHP static method)

Parameter
Coding name	password
Position	1
Parameter of	TopincsUserAccount->activate(PHP instance method)

Parameter
Coding name	type
Description	The content type: Either a shorthand or the exact content-type.
Position	1
Parameter of	content_type(PHP function)
Comments	Defined shorthands: csv, pdf, sql, jpg, zip, plain.

Parameter
Coding name	disposition
Position	2
Parameter of	content_type(PHP function)
Default value	By default the Content-Disposition header is omitted.

Parameter
Coding name	filename
Description	Filename for saving the resource to the filesystem of the browser.
Position	3
Parameter of	content_type(PHP function)
Default value	No filename is used.

Parameter
Coding name	default
Description	The default value to be returned when native is null.
Position	2
Parameter of	format(PHP function)
Default value	The empty string.

Parameter
Coding name	datatype
Description	The datatype. When
Position	3
Parameter of	format(PHP function)
Default value	By default the datatype is guessed based on the PHP type of native.

Parameter
Coding name	key
Description	The key under which the text is addressed.
Position	1
Parameter of	txt(PHP function)

Parameter
Coding name	rest
Description	The remaining arguments are used for replacing occurrences of %n in the translation of the text. With n being a natural number.
Position	2
Parameter of	txt(PHP function)

Parameter
Coding name	col_name
Description	The name of the column to get. Or a reference to another import subject already extracted from this row.
Position	1
Parameter of	DataRow->mand(PHP instance method)
Comments	There is no need to change this in case a column changes name in the source data. Use the <code>options</code> for the <code>TableReader</code> to rename the column.

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	Array(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	col_name
Description	The name of the column to get.
Position	1
Parameter of	DataRow->opt(PHP instance method)

Parameter
Coding name	converter
Description	Name of a function taking a string and returning a PHP type.
Position	2
Parameter of	DataRow->opt(PHP instance method)

Parameter
Coding name	key
Description	The serialization name of the statement type. Prepend a puls sign if statements should be added to existing information in the store.
Position	1
Parameter of	ImportSubject->set(PHP instance method)

Parameter
Coding name	key
Description	The serialization name of the statement type.
Position	1
Parameter of	ImportSubject->replace(PHP instance method)

Parameter
Coding name	key
Description	The serialization name of the statement type.
Position	1
Parameter of	ImportSubject->has(PHP instance method)

Parameter
Coding name	key
Description	A name unique within this import.
Position	1
Parameter of	DataRow->add_import_subject(PHP instance method)

Parameter
Coding name	rel_url
Description	a relative URL.
Position	1
Parameter of	url(PHP function)

Parameter
Coding name	name
Description	The name attribute of the select element.
Position	1
Parameter of	html_select(PHP function)

Parameter
Coding name	null_label
Description	The label of the null option in the select box.
Position	4
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	NULL(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	NULL(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	NULL(Primitive type)
Parameter of	Tobject::make(PHP static method)

Parameter
Coding name	msg
Description	The message. May contain directives in sprintf style which are replaced by the arguments passed after this parameter.
Position	1
Parameter of	debug(PHP function)

Parameter
Coding name	filepath
Description	The path of the file.
Position	1
Parameter of	downscale(PHP function)

Parameter
Coding name	str
Description	The string to be converted into a filename.
Position	1
Parameter of	filename_str(PHP function)

Parameter
Coding name	str
Description	The string to be split into lines.
Position	1
Parameter of	lines(PHP function)

Option
Option map	email data
Coding name	subject
Mandatory	0
Array accepted	0

Option
Option map	email data
Coding name	text
Mandatory	1
Array accepted	0

Option
Option map	email data
Coding name	html
Mandatory	0
Array accepted	0

Option
Option map	smtp options
Coding name	port
Mandatory	1
Array accepted	0
Description	A string holding the port number of the SMTP server

Option
Option map	smtp options
Coding name	security
Mandatory	1
Array accepted	0
Description	A string holding the security protocol. Possible values: "tls".

Option
Option map	smtp options
Coding name	username
Mandatory	1
Array accepted	1
Description	A string holding the username of the SMTP user.

Option
Option map	smtp options
Coding name	password
Mandatory	1
Array accepted	0
Description	A string holding the password of the SMTP user.

Option
Option map	table data
Coding name	empty
Mandatory	0
Array accepted	0
Description	This message will be rendered if the row count is zero.

Option
Option map	table data
Coding name	sort
Mandatory	0
Array accepted	0
Description	A string holding the index of the column that the table is initially sorted by. Counting starts at 1. Separated by space when there is more than one column used for sorting. The sorting itself has to be done in the service code. Prefix the column index with a MINUS sign to reverse sort direction.

Parameter
Coding name	property
Description	Name of the property to sort by. Prepend a minus to revert sort direction.
Position	2
Parameter of	sort_objects(PHP function)
Comments	The function accepts any number of property names.
Examples	price -date

Option
Option map	image
Coding name	cid
Mandatory	1
Array accepted	0

Option
Option map	image
Coding name	name
Mandatory	0
Array accepted	0

Parameter
Coding name	filename
Position	1
Parameter of	twig(PHP function)

Option
Option map	table data
Coding name	id
Mandatory	0
Array accepted	0
Description	When given, the table preserves state upon navigation.

Option
Option map	file
Coding name	name
Mandatory	0
Array accepted	0

Parameter
Coding name	str
Description	The string to extract consonants from.
Position	1
Parameter of	consonants(PHP function)

Parameter
Coding name	str
Description	The string to extract digits from.
Position	1
Parameter of	digits(PHP function)

Option
Option map	options
Coding name	id
Mandatory	0
Array accepted	0
Description	The HTML id of the select-char element. When present the component preserves state.

Parameter
Coding name	service_fn
Description	The formal name of the service.
Position	1
Parameter of	ServiceCall->__construct(PHP instance 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	NULL(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	NULL(Primitive type)
Parameter of	ServiceCall->post(PHP instance method)
Default value	No extension, so null. Most services only have one representation.
Examples	txt json

Option
Option map	table data
Coding name	format
Mandatory	0
Array accepted	0
Description	Accepted values are "html" (default), "csv" and "xlsx".

Parameter
Coding name	str
Position	1
Parameter of	parse_float(PHP function)

Parameter
Coding name	title
Position	1
Parameter of	html_title(PHP function)

Parameter
Coding name	lang
Description	A two letter iso code for a language, e.g. "en" or "de".
Position	1
Parameter of	html_lang(PHP function)

Parameter
Coding name	message
Description	A natural language text that can be presented to the user to help them understand what is wrong and possibly correct the error.
Position	1
Parameter of	StateException->__construct(PHP instance method)

Parameter
Coding name	str
Position	1
Parameter of	letters(PHP function)

Parameter
Coding name	who
Description	A user group, user, or user account who should notified. Either as a tobject, a topic reference or simply a username.
Position	1
Type	Tobject(PHP class) Topic reference(Custom type)
Parameter of	AbstractNoteTemplate->to(PHP instance method)

Parameter
Coding name	location
Description	A URL.
Position	1
Parameter of	redirect(PHP function)

Parameter
Coding name	html
Description	The html document or fragment.
Position	1
Parameter of	inline_css(PHP function)

Parameter
Coding name	datatype
Position	3
Parameter of	DataRow->mand(PHP instance method)
Default value	string.
Comments	Value space: data, time, datetime, integer, decimal, boolean.

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

Parameter
Coding name	format
Description	The format, if supported by the datatype.
Position	3
Parameter of	convert(PHP function)
Default value	For date: Y-m-d For time: h:i:s For datetime: Y-m-d h:i:s
Comments	For boolean: * %true%: 1 * %false%: 0

Parameter
Coding name	id
Description	The id of the element.
Position	3
Type	NULL(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	NULL(Primitive type)
Parameter of	select_char(PHP function)
Default value	span
Introduced in	Topincs 9.0.0

Parameter
Coding name	from
Position	3
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	subject
Position	4
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

Parameter
Coding name	text
Description	The message in text format.
Position	5
Parameter of	email(PHP function)
Introduced in	Topincs 9.0.0

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

Parameter
Coding name	format
Description	The format of the table. Either html, xlsx or csv.
Position	4
Parameter of	table(PHP function)
Default value	html

Parameter
Coding name	empty
Description	A simple string, if the table has zero rows.
Position	5
Parameter of	table(PHP function)
Default value	The empty string.

Parameter
Coding name	style
Description	The table style. Currently there is only one supported table style called 'tom'.
Position	6
Parameter of	table(PHP function)
Default value	tom

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	NULL(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	id
Description	The id of the table.
Position	10
Type	NULL(Primitive type)
Parameter of	table(PHP function)
Comments	Only supported if format is %html%.

Parameter
Coding name	url
Position	1
Parameter of	fetch(PHP function)

Parameter
Coding name	method
Description	The HTTP verb, GET or POST.
Position	2
Parameter of	fetch(PHP function)
Default value	GET

Parameter
Coding name	body
Description	The body of the request to send.
Position	3
Parameter of	fetch(PHP function)
Default value	The empty string, so no body is sent.

Parameter
Coding name	html
Description	The HTML source code of the PDF.
Position	1
Parameter of	pdf(PHP function)

Parameter
Coding name	size
Description	The size of the document.
Position	2
Parameter of	pdf(PHP function)
Default value	A4

Parameter
Coding name	orientation
Description	The orientation of the document.
Position	3
Parameter of	pdf(PHP function)
Default value	portrait

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

Parameter
Coding name	message
Description	The message to show.
Position	1
Parameter of	showMessage(JavaScript function)

Parameter
Coding name	message
Description	The confirmation message to display.
Position	1
Parameter of	showConfirmation(JavaScript function)

Parameter
Coding name	url
Description	The URL to go to. Within the store the store it is recommended to use relative URLs.
Position	1
Parameter of	goto(JavaScript function)

Parameter
Coding name	service
Description	The formal name of the service.
Position	1
Parameter of	schedule(PHP function)

Parameter
Coding name	service
Description	The formal name of the service.
Position	1
Parameter of	call(PHP function)

Parameter
Coding name	service
Description	The formal name of the service.
Position	1
Parameter of	href(PHP function)

Parameter
Coding name	filename
Position	1
Parameter of	php(PHP function)

Parameter
Coding name	description
Description	The value of og:description meta tag.
Position	1
Type	NULL(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	NULL(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	NULL(Primitive type)
Parameter of	html_meta(PHP function)
Default value	The name of the service, when not overridden by html_title.

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

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

Parameter
Coding name	inline
Position	11
Type	Array(Primitive type)
Parameter of	email(PHP function)

Parameter
Coding name	last_value
Description	The new last_value the sequence should take. The empty string resets it to the beginning.
Position	1
Parameter of	TopincsSequence->manipulate(PHP instance method)

String

Declaration name

Return value of34

Type of100

See also

We are sorry

Refreshed unknown