AppGini PHP functions reference

Applies a filter to the current table by adding it to the $_REQUEST global variable.

AppGini supports up to 80 filters grouped into 20 groups. When building the WHERE clause of the table view, each filter group is wrapped in parentheses when combined with the next filter group.

True on success or false on error.

// add this code to the tablename_init hook function
// to apply a default filter displaying today's orders
// assuming the index of the 'order_date' field is 5

addFilter(1, 'and', 5, 'equal-to', date(app_datetime_format()));

Returns the configured date or date/time format for this application.

String, the date or date/time format string.

$phpDateFormat = app_datetime_format();
echo 'Today is ' . date($phpDateFormat);

$phpDTFormat = app_datetime_format('php', 'dt');
echo 'Current date and time: ' . date($phpDTFormat);

Use this function to retrieve the URI (Uniform Resource Identifier) of a page inside the current AppGini app. See also application_url().

String. URI of the provided page, or app homepage if no page provided.

// Let's assume the URL of our AppGini app is
// https://www.goodcompany.com/hr-app/

application_uri(); // => 'hr-app'
application_uri('hooks/payroll-report.php'); // => 'hr-app/hooks/payroll-report.php'

Returns the absolute URL of the provided page, or the homepage URL if no page provided.

String. The absolute URL of the provided page.

// Let's assume the URL of our AppGini app is
// https://www.goodcompany.com/hr-app/

application_url(); // => 'https://www.goodcompany.com/hr-app'
application_url('hooks/payroll-report.php'); // => 'https://www.goodcompany.com/hr-app/hooks/payroll-report.php'

replaces all variations of HTML
tags with a new line character

return text with new line instead of

echo br2nl("hello<br>all");
/* outputs:
hello
all
*/

returns true if current user has the specified permission $perm (view, edit or delete) for the given record, false otherwise

True if current user has the specified permission $perm (view, edit or delete) for the given recors, false otherwise

%EXAMPLE%

clear all filters

None

%EXAMPLE%

Retrieves the configured value of the provided config setting.

Mixed, the value of the config setting.

echo config('host'); // the name of the server

// retrieve the records per page in listings displayed in the admin area
echo config('adminConfig')['recordsPerPage'];

Adds a CSRF token to a form, or validates a submitted CSRF token. CSRF tokens protect pages from malicious submissions that pretend to come from a valid user.

Based on input parameters, returns either a CSRF token value, optionally wrapped in an html hidden input code to insert into the form to be protected, or a boolean indicating if provided CSRF token is valid or not.

// to insert CSRF token into a form, call without parameters inside the form HTML
echo csrf_token();

// to validate submitted requests:
if(!csrf_token(true)) die('Invalid CSRF token');

// to obtain token value without wrapping in an HTML hidden input,
// for example to use in an ajax request:
echo csrf_token(false, true);

Get number of affected rows in previous database operation

number of affected rows in previous database operation

%EXAMPLE%

closes the connection to db link

None

%EXAMPLE%

Open a connection to a database Server

a database link identifier on success or FALSE on failure.

%EXAMPLE%

Returns the numerical value of the error message from previous database operation

The numerical value of the error message from previous database operation

%EXAMPLE%

Returns the text of the error message from previous database operation

The text of the error message from previous database operation

%EXAMPLE%

Escapes a string for use in a database_query

The escaped string.

%EXAMPLE%

Fetch a result row as an associative array, a numeric array, or both

array of query results

%EXAMPLE%

converts the result row of query to associative array

An array of query result row

%EXAMPLE%

Get a result row as an enumerated array

An enumerated array

%EXAMPLE%

Get the name of the specified field in a result

the name of the specified field in a result

%EXAMPLE%

Get the type of the specified field in a result

The type of the specified field in a result

%EXAMPLE%

Get the ID generated in the last insert query

The ID generated in the last query

%EXAMPLE%

defines satic var of database connection link and sets it by input link if found

A database link

%EXAMPLE%

Get number of fields in query result

number of fields in query result

%EXAMPLE%

Get number of rows in query result

number of rows in query result

%EXAMPLE%

execute a database query

result of execute database query

%EXAMPLE%

selects specifying database

None

%EXAMPLE%

Returns the default app config template.

Associative array, the default config template.

%EXAMPLE%

Checks if the app has a config file, and optionally redirects to app setup page if no config found.

Boolean, true if config file found, false otherwise.

%EXAMPLE%

converts unicode entities (e.g. Ӓ) to actual UTF8 characters, requires multibyte string PHP extension

UTF8 characters

%EXAMPLE%

returns html code for a styled error message .. pass explicit false in second param to suppress back button

html code for a styled error message

%EXAMPLE%

Retrieves the username of the current user if she's the admin.

the username of the current user if she's the admin, or false otherwise.

%EXAMPLE%

Retrieves member information

An associative array of Member information as detailed here.

%EXAMPLE%

gets primary key field name of given table

A primary key of given table

%EXAMPLE%

Retrieves a record from the specified table, given its primary key value. Warning: No ownership checks are made when executing this function.

The requested record as an associative array (field names as keys, stored data as values), or false on error.

%EXAMPLE%

An associative array (tableName => tableData, tableData is array(tableCaption, tableDescription, tableIcon)) of tables accessible by current user

%EXAMPLE%

get table permissions

An array of permissions allowed for logged member to given table (allowAccess, allowInsert, allowView, allowEdit, allowDelete) -- allowAccess is set to true if any access level is allowed

%EXAMPLE%

get Value executes select query with given condition

a result of executing select query with given condition

%EXAMPLE%

returns embed code for a given url (supported providers: youtube, googlemap)

embed code for a given url (supported providers: youtube, googlemap)

%EXAMPLE%

get embeded google map provider

embed code for a given url supported provider:googlemap

%EXAMPLE%

None

%EXAMPLE%

scans for installed plugins

installed plugins in an array ('name', 'title', 'icon' or 'glyphicon', 'admin_path')

%EXAMPLE%

returns the SELECT part of the table view query

The SELECT part of the table view query

%EXAMPLE%

returns the FROM part of the table view query, with full joins, optionally skipping permissions if true passed as 2nd param.

the FROM part of the table view query, with full joins, optionally skipping permissions if true passed as 2nd param.

%EXAMPLE%

returns an associative array (table_group => tables_array)

An associative array (table_group => tables_array)

%EXAMPLE%

prepare $str to be placed inside an HTML attribute by Converting special characters to HTML entities

HTML entities

%EXAMPLE%

Added in AppGini 5.71. Same as html_attr, except that HTML tags are allowed

HTML entities

%EXAMPLE%

checks if the input field is Email or not

returns $email if valid or false otherwise

%EXAMPLE%

returns true if this is an ajax request, false otherwise

true if this is an ajax request, false otherwise

%EXAMPLE%

checks if input username is allowed or not

true if username allowed, false otherwise

%EXAMPLE%

Loads a given view from the templates folder, passing the given data to it

the output of the parsed view as a string

%EXAMPLE%

Destroys current session, thus logging out current user. You might need to redirect users to the login page or some custom goodbye page after calling this function.

None

%EXAMPLE%

Escapes a string to be placed safely in an SQL query. If the 2nd parameter is not provided (or is set to true) the string is escaped only if magic quotes are turned on. So, this is useful if the string is coming from the request parameters or cookies. To always escape the string, set the 2nd parameter to false.

A string ready to be placed safely in an SQL query

$unsafe = "unsafe 'string'";
$safe = makeSafe($unsafe, false);
echo $safe; // unsafe \'string\'

Generates the HTML code for the table drop-downs in the top navigation, listing only the tables that are accessible to the current user. Usually, you won't need to use this function unless you are not including the generated header.php in your custom page.

String, the HTML code for insertion in the navigation bar.

%EXAMPLE%

returns an array containing the FROM and WHERE additions for applying permissions to an SQL query

An array containing the FROM and WHERE additions for applying permissions to an SQL query

%EXAMPLE%

Handles file uploading made via a form submission, storing the uploaded file, if valid, in the specified folder. Warning: If handling fails, the function would abort execution with an error message, but this behavior might change in future releases.

String, the (renamed) file name on success, or an empty string on failure.

if($newFilename = PrepareUploadedFile('profile_photo', 1024 * 1024)) {
    echo '<img src="images/' . $newFilename . '">';
    echo '<br>Profile photo updated successfully!';
} else {
    echo 'Error updating your profile photo!';
} else {

returns a copy of the given array, with keys replaced by 1-based numeric indices, and values replaced by original keys

a copy of the given array, with keys replaced by 1-based numeric indices, and values replaced by original keys

%EXAMPLE%

uses to redirect to absolute url or relational url

None

%EXAMPLE%

None

%EXAMPLE%

returns html code for displaying a notification. If no parameters provided, processes the GET request for possible notifications.

html code for displaying a notification. If no parameters provided, processes the GET request for possible notifications.

%EXAMPLE%

executes given $query and returns its result set. $o is an options array

The result set returned from the query

$res = sql("select name, email from customers", $o);
while($cust = db_fetch_assoc($res)){
    echo "Name: {$cust['name']}<br>";
    echo "Email: {$cust['email']}<br>";
    echo "<hr>";
}

Executes a database query that retreives a single data value and returns the value retrieved.

The single value retrieved from the provided query.

$sales = sqlValue("select sum(total) from orders");

gets time in 12-hour format

if there is input time convert it to 12-hour format. else, gets the current time in 12-hour format

%EXAMPLE%

gets time in 24-hour format

if there is input time convert it to 24-hour format. else, gets the current time in 24-hour format

%EXAMPLE%

gets the size of input string in bytes unit

The size of input string in bytes

%EXAMPLE%

Converts a date from AppGini-configured date format to MySQL format of Y-m-d.

The date in MySQL format.

%EXAMPLE%