Xataface Wiki | Wiki

about

Field

Value

Page name

about

Page id

Page title

about

Content

About Xataface

Table of Contents

About Xataface

Xataface is a flexible and shapable skin that sits on top of MySQL, making it accessible to every-day users. It automatically generates the appropriate forms, lists, and menus for a user to interact with the database witho

Language

actions.ini_file

Field

Value

Page name

actions.ini_file

Page id

Page title

actions.ini_file

Content

actions.ini file Reference

Table of Contents

actions.ini file Reference

The actions.ini file stores information about the various action?s that can be performed by your application. An action may be manifested in two ways:

As a web page
As a menu item

And there is no

Language

advmultiselect

Field	Value
Page name	advmultiselect
Page id	183
Language	en

afterCopy

Field

Value

Page name

afterCopy

Page id

123

Page title

afterCopy Delegate class Method

Content

Return to Delegate class methods

Table of Contents

Synopsis

A delegate class method that will be executed after a record is copied using the copy set or copy selected function. All xataface copies are shallow which means that related records are

Keywords

afterCopy, copy record hook

Language

afterRegister

Field	Value
Page name	afterRegister
Page id	14
Page title	afterRegister
Content	afterRegister() Trigger A trigger that can be implemented in the Application Delegate Class or the Table Delegate Class?, to be executed after the registration form is saved. This can be used to perform some custom actions like emailing the
Language	en

after_action_activate

Field

Value

Page name

after_action_activate

Page id

181

Page title

after_action_activate Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

The after_action_activate hook is a method that can be defined in the Application Delegate Class which is called after an account has been activated via the registration process. The full

Keywords

Registration, activation, register, activate, users

Language

after_action_new

Field

Value

Page name

after_action_new

Page id

Page title

after_action_new

Content

after_action_new trigger

Table of Contents

after_action_new trigger

This trigger is called after the new action is successfully completed. This trigger can be defined in the table delegate class and is often used to redirect to a particular page

Language

Application_Delegate_Class

Field

Value

Page name

Application_Delegate_Class

Page id

Page title

Application Delegate Class

Content

Table of Contents

Synopsis

The application delegate class is similar to the table_delegate_class except that it is applicable to the application as a whole, not just one table. It allows the developer to implement hooks that

Keywords

application delegate class

Language

Authenticating_Against_the_Joomla!_Users_Table

Field	Value
Page name	Authenticating_Against_the_Joomla!_Users_Table
Page id	93
Content	Xataface is able to use the joomla users table to authenticate against so that, you can allow your users to log into your Xataface application using the same credentials as they use to access your joomla website. Achieving this level of integration requir
Keywords	joomla authentication md5
Language	en

Authenticating_Against_the_PHPBB_Users_table

Field

Value

Page name

Authenticating_Against_the_PHPBB_Users_table

Page id

Page title

Authenticating Against the PHPBB Users Table

Content

Return to authentication

Table of Contents

Xataface is able to use the PHPBB users table to authenticate against so that, you can allow your users to log into your Xataface application using the same credentials as they use to access your PHPBB message fo

Keywords

PHPBB, authentication, security, authentication modules

Language

authentication

Field

Value

Page name

authentication

Page id

Page title

authentication

Content

Xataface Authentication

Table of Contents

Xataface Authentication

Xataface comes with authentication ready to roll out of the box. With a couple of configuration options in the conf.ini file, you can activate the default authentication scheme which uses a table (o

Keywords

authentication, [_auth], CAS Authentication, Authentication Modules, Basic Authentication, Security

Language

beforeAddRelatedRecord

Field

Value

Page name

beforeAddRelatedRecord

Page id

108

Page title

beforeAddRelatedRecord Delegate Class Method

Content

Return to Delegate class methods

Table of Contents

Synopsis

The beforeAddRelatedRecord delegate class method can be implemented in any table's delegate class. It will be executed before any related record is added to that table's relationships

Keywords

beforeAddRelatedRecord, Delegate class methods, relationship triggers

Language

beforeCopy

Field

Value

Page name

beforeCopy

Page id

124

Page title

beforeCopy Delegate Class Method

Content

Return to Delegate class methods

Table of Contents

Synopsis

A delegate class method that will be executed before a record is copied using the copy set or copy selected function. All xataface copies are shallow which means that related records ar

Keywords

beforeCopy, copy records

Language

beforeHandleRequest

Field

Value

Page name

beforeHandleRequest

Page id

107

Page title

beforeHandleRequest Application Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

Synopsis

The beforeHandleRequest method is a very useful hook that can be implemented in an Application Delegate Class to perform some processing before every request.

This hook is c

Keywords

beforeHandleRequest, Application Delegate

Language

beforeRegister

Field	Value
Page name	beforeRegister
Page id	13
Page title	beforeRegister
Content	beforeRegister() Trigger A trigger that can be implemented in the Application Delegate Class or the Table Delegate Class?, to be executed before the registration form is saved. This can be used to perform some custom actions like emailing t
Language	en

beforeSave

Field

Value

Page name

beforeSave

Page id

109

Page title

beforeSave Trigger

Content

Back to Delegate class methods

Table of Contents

Synopsis

The beforeSave trigger can be implemented in any table's Delegate Class Methods? to perform functionality that should be run *before* a record of that table is saved.

Keywords

triggers, beforeSave,

Language

before_authenticate

Field	Value
Page name	before_authenticate
Page id	102
Page title	before_authenticate hook
Content	Return to Application Delegate Class The before_authenticate hook is a method that can be defined in the Application Delegate Class which is called before the authentication step occurs on every request (not just on login). It is m
Keywords	authentication
Language	en

blob

Field	Value
Page name	blob
Page id	55
Page title	blob
Language	en

block__blockname

Field	Value
Page name	block__blockname
Page id	11
Page title	block__blockname
Content	Available Blocks This is a grep to show the blocks that are defined in Xataface templates: Dataface_ActionsMenu.html:actions_menu_head Dataface_ActionsMenu.html:actions_menu_tail Dataface_Add_Existing_Related_Record.html:before_add_exi
Language	en

Cached_permissions

Field	Value
Page name	Cached_permissions
Page id	179
Page title	Cached Permissions
Content	Cached Permissions Introduction When you insert a SQL query in your getPermissions function, this will slow down the app dramatically because this function is called by each query. To resolve this problem, it is better to use cached permissi
Keywords	permissions, cache, quick, query
Language	en

calendar

Field

Value

Page name

calendar

Page id

100

Page title

Calendar Widget

Content

Back to widget:type

Table of Contents

Synopsis

The calendar widget is the default widget for editing date and datetime fields. It is javascript pop-up calendar that allows users to select date and time visually. It can be configured to allow di

Keywords

calendar widget, fields.ini file, widget:type

Language

Calendar_Action

Field

Value

Page name

Calendar_Action

Page id

Page title

Calendar_Action

Content

Calendar Action

Table of Contents

Calendar Action

Xataface 1.0 includes a built-in calendar action that is disabled by default. If enabled, it allows you to view the records in any found set as a calendar of events, as follows:

<nowiki> <div style="text-align:center

Language

checkbox

Field	Value
Page name	checkbox
Page id	69
Page title	checkbox
Content	The checkbox widget In the fields.ini file you can specify a field to be edited using a checkbox widget by setting widget:type to checkbox. A checkbox widget can function in 2 different ways depending on the parameters that you assign
Language	en

Clean_the_html_for_the_export

Field	Value
Page name	Clean_the_html_for_the_export
Page id	178
Page title	Clean the HTML to export data
Content	Clean HTML tags and entities to export your data Override the display() of the field to strip the tags... but this would affect all parts of the application where the HTML fields are displayed. Create a grafted field, then override its display to
Language	en

column:legend

Field	Value
Page name	column:legend
Page id	182
Language	en

conf.ini_file

Field

Value

Page name

conf.ini_file

Page id

Page title

conf.ini_file

Content

conf.ini File

Table of Contents

conf.ini File

The conf.ini file is where most of the application-level configuration information is stored for a Xataface application. It contains information such as:

database connection information
which tables should appear i

Language

Contribute_to_Xataface_Translation_Project

Field

Value

Page name

Contribute_to_Xataface_Translation_Project

Page id

110

Page title

How to Contribute Translations

Content

Table of Contents

Synopsis

Xataface stores its translations in INI files in its lang directory, one for each language. You can develop your own translation by first copying the en.ini file to xx.ini (where xx is the ISO language code for the language you

Keywords

Translations, Google Spreadsheets, en.ini, fr.ini

Language

Creating_a_Dashboard

Field

Value

Page name

Creating_a_Dashboard

Page id

Page title

Creating_a_Dashboard

Content

Creating a Dashboard for your Users

Table of Contents

Creating a Dashboard for your Users

Xataface allows you to build powerful data-driven applications quickly, but these applications may be daunting to your users if they don't know what they can do with the application. Most applications

Keywords

dashboard

Language

Creating_Printable_Reports

Field

Value

Page name

Creating_Printable_Reports

Page id

Page title

Creating a Custom Printable Report

Content

Creating a Printable Report

Table of Contents

Creating a Printable Report

It is often useful to provide your users with a printable report that is generated from your database. Although Xataface doesn't include an explicit reporting module to allow the end users to create their own

Language

Customizing_Theme_Based_on_IP_Address

Field	Value
Page name	Customizing_Theme_Based_on_IP_Address
Page id	103
Page title	Customizing Theme Based on IP Address
Content	This article deals with the following topics: Using field__pullValue/field__pushValue methods to customize how a field is edited and stored in the database. Using beforeHandleRequest to modify the application settings based on the user
Keywords	ip address, pullValue, pushValue, beforeHandleRequest
Language	en

Xataface Wiki | Wiki

about

About Xataface

actions.ini_file

actions.ini file Reference

advmultiselect

afterCopy

Synopsis

afterRegister

afterRegister() Trigger

after_action_activate

after_action_new

after_action_new trigger

Application_Delegate_Class

Synopsis

Authenticating_Against_the_Joomla!_Users_Table

Authenticating_Against_the_PHPBB_Users_table

authentication

Xataface Authentication

beforeAddRelatedRecord

Synopsis

beforeCopy

Synopsis

beforeHandleRequest

Synopsis

beforeRegister

beforeRegister() Trigger

beforeSave

Synopsis

before_authenticate

blob

block__blockname

Available Blocks

Cached_permissions

Cached Permissions

Introduction

calendar

Synopsis

Calendar_Action

Calendar Action

checkbox

The checkbox widget

Clean_the_html_for_the_export

Clean HTML tags and entities to export your data

column:legend

conf.ini_file

conf.ini File

Contribute_to_Xataface_Translation_Project

Synopsis

Creating_a_Dashboard

Creating a Dashboard for your Users

Creating_Printable_Reports

Creating a Printable Report

Customizing_Theme_Based_on_IP_Address