Primitive type

Boolean

Declaration name

bool

Return value of6

current_user_in_class(PHP function)

ImportSubject->has(PHP instance method)

Tobject->equals(PHP instance method)

Tobject->isa(PHP instance method)

TopincsUserAccount->is_active(PHP instance method)

user(PHP function)

Type of19

Parameter
Coding name	typed
Position	1
Parameter of	Tobject->label(PHP instance method)
Default value	true

Parameter
Coding name	typed
Position	1
Parameter of	Tobject->a(PHP instance method)
Default value	true

Parameter
Coding name	throw
Description	Wether a MatchingException is thrown when there is no matching topic found in the database.
Position	2
Parameter of	Matcher::match(PHP static method)
Default value	True. A MatchingException is thrown by default.

Option
Option map	smtp options
Coding name	debug
Mandatory	0
Array accepted	0
Description	When set to true, the protocol dialog during connection establishment will be writtten into debug.

Option
Option map	table data
Coding name	sortable
Mandatory	0
Array accepted	0
Description	The table will be sortable by all columns in the browser.

Parameter
Coding name	i18n
Description	A flag for internationalization. If true, the URL will be localized to the current language in a multilingual store, if address variants are defined.
Position	1
Parameter of	ServiceCall->href(PHP instance method)
Default value	No localization.

Parameter
Coding name	sticky
Description	Whether the ticket remains in the browser address bar after being used.
Position	3
Parameter of	ticket(PHP function)
Default value	False. The ticket is not sticky.
Comments	If users need to bookmark or share the URL, it is recommended to make the ticket sticky. For some user groups it makes sense to give them only access via tickets. They might be even unaware of their username and password. Then, if they bookmark the page of a non-sticky ticket, they will be challenged after revisiting the page once they closed their browser or the session expired.

Parameter
Coding name	with_query_string
Position	1
Parameter of	current_url(PHP function)
Default value	True. If a query string is present, it is appended.

Parameter
Coding name	stateless
Description	If the client just sends a single request, e.g. a foreign system requesting or providing information via HTTP.
Position	4
Parameter of	ticket(PHP function)
Default value	False. The ticket creates a session.

Parameter
Coding name	uppercase
Description	Whether given names are uppercased.
Position	6
Parameter of	select_char(PHP function)
Default value	true
Introduced in	Topincs 9.0.0

Parameter
Coding name	striped
Description	Whether the table should be striped.
Position	7
Type	Integer(Primitive type)
Parameter of	table(PHP function)
Default value	0, the table is not striped.
Comments	* 0, false: the table is not striped. * 1, true: odd lines are highlighted. * 2: even lines are highlighted. Only supported with format %html%.

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

Parameter
Coding name	compress
Description	Wheter the PDF should be compressed.
Position	4
Parameter of	pdf(PHP function)
Default value	true

Parameter
Coding name	debug
Description	Detailed information will be written to debug.
Position	6
Parameter of	fetch(PHP function)
Default value	False, no debug inforamation is written.

Parameter
Coding name	empty
Description	Whether empty lines should be included.
Position	1
Parameter of	lines(PHP function)
Default value	False, empty lines are not included.

Parameter
Coding name	trim
Description	Whether all whitespace should be trimmed on both sides of the line.
Position	2
Parameter of	lines(PHP function)
Default value	True, whitespace is trimmed.

Parameter
Coding name	newline
Description	Whether the newline should be kept at the end of the line.
Position	3
Parameter of	lines(PHP function)
Default value	Fasle, newlines are not kept.

Parameter
Coding name	debug
Description	Debug SMPT protocol communication.
Position	12
Parameter of	email(PHP function)
Default value	false

Parameter
Coding name	location
Description	Just get the location of a redirect response.
Position	9
Parameter of	fetch(PHP function)

See also

php.net/…ual/en/language.types.boolean.php

Saving …

Before we continue …

No internet connection