OOP plays a central role for Topincs when working with data in the store. Tobjects represent topics and domain classes are used for type specific behavior. For almost everything else there is simply a global function.
This is delibarate choice to increase productivity. Always use the simplest concept that works! Even the smallest unnecessary increase in complexity will slow you down in a frequent task like programming PDF or email generation, therefore neither classes nor namespaces. It should be as simple as a function call.
Call a service in the current PHP process.
Require the session to contain a task and the request to contain its correct solution. If either one is missing, the request execution is stopped and a randomly selected task is sent to the client.
Extract consonants from a string after converting all letters to lower case.
Write out the HTTP header Content-Type.
Convert a string into the PHP representation.
Get the current url of the service.
Return the current user, a tobject representing him or her in the domain. The type of the tobject varies depending on the schema.
Return the current user account, a tobject of type user account.
Return the numeric id of the user group the current user account is a member of. The id of the user group unauthenticated is always 0, independent of the actual system id of the topic representing this user group.
Return true if the currently logged in user is in the given class, otherwise false.
Return the user name of the current logged in user. Return NULL if no one is logged in.
Write debug information. Works like sprintf. Access the information through the Admin menu > Debug.
Extract digits from a string.
Reduce the height of the image when its higher than a given maximum height. Changes to the JPEG format as well. The file will be overwritten.
Send an email. Supports HTML, attachments and inlined images.
Fetch or post something with http, ftp or imap.
Converts any string into a string which can be used as a filename.
Format a native PHP object or scalar into a HTML string which will be rendered internationalized on the client.
Get the URL of a service call to be used in a href attribute of link, most likely.
Override the negotiated UI lanuage in a mutilingual store. This is useful when a service is made available in a single language only with inline forms or service calls.
Add Open Graph or other meta tags to HTML output of a service.
Override the default HTML title (the label of the service) that Topincs sets on the page.
Ignore frozen generally to make changes to any topic, even if is frozen.
Evaluate imported css or scss and add result to style attributes of affected elements.
Change the language to a specific one. Labels, the txt function family, as well as the txt function will respect this. Return back to initial languge, by passing nothing.
Extract letters from a string and convert to lower case.
Splits a string into lines. Returns by default an array of trimmed, non-empty lines within the string. Recognizes all types of line endings.
Create a notification.
Turn note generation off. This avoids flooding users with notes during bulk import of data.
Parse exactly one float from a string.
Create a pdf. Returns the PDF as a string.
Use php templates, in particular helpful when creating HTML emails or PDFs.
Prepare bulk subject identifier resolution, by loading them into memory.
Update the progress for the current process in the session.
Create a random string of given length.
Send a location header.
Respect frozen status of tobjects when using the API. Return to default behavior after calling ignore_frozen.
Schedule a service call as a job for background execution.
Returns the HTML markup for a select-char given a list of names. Characters not appearing as a first letter will be rendered inactive.
Return the next value according to the definition of the sequence.
Sort an array of objects by one or more properties.
Render data as a table in various formats: HTML (default), CSV, or XLSX.
Fetch a ticket for a user A for appending to an URL and sending in an email. Using this URL will automatically login A.
Create a temporary directory that will be automatically removed when PHP terminates. Return the complete path of the directory.
Create a temporary file which is automatically deleted when the request finishes.
Use twig templates, in particular helpful when creating HTML emails or PDFs.
Retrieve a string in the current user interface language. Or in a specific language. Parameters after the key are substituted in order for %1, %2, etc.
Take a relative URL and turn it into an absolute store URL.
This page cannot be displayed in your browser. Use Firefox, Opera, Safari, or Chrome instead.
Before we continue …