Xataface Wiki | Wiki

index_page

Field

Value

Page name

index_page

Page id

Page title

index_page

Content

Documentation

Table of Contents

Documentation

Introductory

About Xataface
Getting Started Tutorial
How to build a PHP MySQL Application with 4 lines of code
[[Troubleshooting

Language

testpage2

Field	Value
Page name	testpage2
Page id	2
Page title	testpage2
Content	Another test page testpage?
Language	en

fields.ini_file

Field

Value

Page name

fields.ini_file

Page id

Page title

fields.ini_file

Content

fields.ini File Reference

Table of Contents

fields.ini File Reference

Overview

The fields.ini file is a configuration file which is associated with a single table of a database application. It provides metadata about the table's fields to help Xataface dictate how they s

Keywords

fields.ini directives

Language

widget:type

Field	Value
Page name	widget:type
Page id	4
Page title	widget:type
Content	widget:type Directive Reference The widget:type directive in the fields.ini file specifies the type of widget that should be used to edit a particular field in HTML forms. Xataface uses [http://pear.php.net/package/HTML_QuickForm/ HTML_QuickFo
Language	en

valuelists.ini_file

Field

Value

Page name

valuelists.ini_file

Page id

Page title

valuelists.ini_file

Content

valuelists.ini file Reference

Table of Contents

valuelists.ini file Reference

The valuelists.ini file stores value lists that can be used as vocabularies? for select lists, checkbox groups, and other widgets the provide the user with options to choose from.

Each table

Keywords

valuelists, dynamic valuelists, programmatically defined valuelists

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

Delegate_class_methods

Field

Value

Page name

Delegate_class_methods

Page id

Page title

Delegate_class_methods

Content

Delegate Class Reference

Table of Contents

Delegate Class Reference

A delegate class is a PHP class that complements a particular table with custom bahaviors. Basic table metadata can be supplied using the fields.ini file, however some things are better customized using PHP.

Keywords

RSS,Feeds,delegate classes, triggers

Language

Internet_Media_Manager

Field

Value

Page name

Internet_Media_Manager

Page id

Page title

Internet Media Manager

Content

Manage your videos and photos all in one place

Table of Contents

Watch the Guided Tour (6 minutes)

<nowiki> <embed src="http://media.weblite.ca/lib/flvplayer.swf" width="640" height="448" bgcolor="#FFFFFF" type="application/x-shockwave-flash" pl

Keywords

Internet Media Manager,resize photos,image gallery,photo gallery,video gallery

Language

prefs

__prefs__

Field	Value
Page name	__prefs__
Page id	9
Page title	__prefs__
Content
Language	en

preferences

Field

Value

Page name

preferences

Page id

Page title

preferences

Content

Xataface Preferences

Table of Contents

Xataface Preferences

Xataface preferences can be defined in 3 ways:

In the [_prefs] section of rhe conf.ini file for global static preferences.
Implementing the getPreferences? method in the [[Application Delegate Clas

Keywords

preferences, prefs, getPreferences

Language

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

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

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

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

validateRegistrationForm

Field	Value
Page name	validateRegistrationForm
Page id	15
Page title	validateRegistrationForm
Content	validateRegistrationForm() hook A hook that validates the input into the user registration form to make sure that the input is valid. Signature function validateRegistrationForm( array $values ) : mixed Parameters {\| class
Language	en

sendRegistrationActivationEmail

Field	Value
Page name	sendRegistrationActivationEmail
Page id	16
Page title	sendRegistrationActivationEmail
Content	sendRegistrationActivationEmail() Hook A hook that can be implemented in the Application Delegate Class or the Table Delegate Class? to override the sending of an activation email to the user. Signature function sendRegistrationA
Language	en

getRegistrationActivationEmailInfo

Field	Value
Page name	getRegistrationActivationEmailInfo
Page id	17
Page title	getRegistrationActivationEmailInfo
Content	getRegistrationActivationEmailInfo() Hook A hook that can be implemented in the Application Delegate Class or the Table Delegate Class? to override the default information that is used to send the registration activation email (the email tha
Language	en

getRegistrationActivationEmailSubject

Field	Value
Page name	getRegistrationActivationEmailSubject
Page id	18
Page title	getRegistrationActivationEmailSubject
Content	getRegistrationActivationEmailSubject() Hook A hook that can be implemented in the Application Delegate Class or the Table Delegate Class? to override the default registration activation email subject line (the email that the user receives w
Language	en

getRegistrationActivationEmailMessage

Field	Value
Page name	getRegistrationActivationEmailMessage
Page id	19
Page title	getRegistrationActivationEmailMessage
Content	getRegistrationActivationEmailSubject() Hook A hook that can be implemented in the Application Delegate Class or the Table Delegate Class? to override the default registration activation email message body (the email that the user receives w
Language	en

relationships.ini_file

Field

Value

Page name

relationships.ini_file

Page id

Page title

relationships.ini_file

Content

relationships.ini File Reference

Table of Contents

relationships.ini File Reference

Overview

The relationship.ini file is a configuration file which is associated with a single table of a database application. It provides metadata about the table's relationships to other tables

Keywords

relationships.ini file, relationships

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

Writing_Custom_Authentication_Plugins

Field

Value

Page name

Writing_Custom_Authentication_Plugins

Page id

Page title

Writing_Custom_Authentication_Plugins

Content

Writing a Custom Authentication Plugin for Xataface

Table of Contents

Writing a Custom Authentication Plugin for Xataface

Xataface has a pluggable authentication framework that allows you to easily write your own custom authentication modules to tie in with other systems. Several plugins have alre

Language

xataface_templates

Field

Value

Page name

xataface_templates

Page id

Page title

xataface_templates

Content

Xataface Templates

Table of Contents

Xataface Templates

Xataface uses the Smarty Template Engine to power all of its templates. Templates are stored in the one of the following locations:

%XATAFACE_ROOT%/Dataface/templates
%SITE_ROOT%/templa

Keywords

templates, plugins, smarty

Language

templates:tags:use_macro

Field	Value
Page name	templates:tags:use_macro
Page id	24
Page title	templates:tags:use_macro
Content	use_macro Template Tag Synopsis The use_macro tag includes another template into the current template with the option to override certain sections. Parameters {\| class="listing listing2" \|- ! Name ! Description ! Version \|
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

permissions.ini_file

Field

Value

Page name

permissions.ini_file

Page id

Page title

permissions.ini_file

Content

The permissions.ini File

Table of Contents

The permissions.ini File

The permissions.ini file stores custom permissions and roles that can be used by an application. It is an optional file that should be placed in the application root directory (i.e. the same directory where your

Keywords

permissions.ini, getPermissions, permissions

Language

filter

Field	Value
Page name	filter
Page id	27
Page title	filter
Content	The filter attribute of the fields.ini file The filter attribute with a value of 1 specifies that a field should be used as a filter field in list view. In list view, any filter fields will provide a select list with all of the possible values
Language	en

group

Field	Value
Page name	group
Page id	28
Page title	group
Content	group directive in fields.ini file The group directive allows you to declare that certain fields of your table should be grouped together on the edit form and the view tab (and other logical places). For example, fields like address, city, sta
Language	en

encryption

Field	Value
Page name	encryption
Page id	29
Page title	encryption
Content	encryption fields.ini file directive The encryption directive is meant to be used on password fields only. It specifies that a certain type of encryption is to be used in the storing of values in this field. For example, many PHP/MySQL
Language	en

modules

Field

Value

Page name

modules

Page id

Page title

Xataface Modules

Content

Table of Contents

Xataface provides a number of hooks that allow developers to create modules to extend its functionality. This page lists a handful of the currently available modules.

Shopping Cart - Converts your application into a shopp

Keywords

modules, captcha

Language

Xataface Wiki | Wiki

index_page

Documentation

Introductory

testpage2

fields.ini_file

fields.ini File Reference

Overview

widget:type

widget:type Directive Reference

valuelists.ini_file

valuelists.ini file Reference

actions.ini_file

actions.ini file Reference

Delegate_class_methods

Delegate Class Reference

Internet_Media_Manager

Watch the Guided Tour (6 minutes)

__prefs__

preferences

Xataface Preferences

block__blockname

Available Blocks

Application_Delegate_Class

Synopsis

beforeRegister

beforeRegister() Trigger

afterRegister

afterRegister() Trigger

validateRegistrationForm

validateRegistrationForm() hook

Signature

Parameters

sendRegistrationActivationEmail

sendRegistrationActivationEmail() Hook

Signature

getRegistrationActivationEmailInfo

getRegistrationActivationEmailInfo() Hook

getRegistrationActivationEmailSubject

getRegistrationActivationEmailSubject() Hook

getRegistrationActivationEmailMessage

getRegistrationActivationEmailSubject() Hook

relationships.ini_file

relationships.ini File Reference

Overview

authentication

Xataface Authentication

Writing_Custom_Authentication_Plugins

Writing a Custom Authentication Plugin for Xataface

xataface_templates

Xataface Templates

templates:tags:use_macro

use_macro Template Tag

Synopsis

Parameters

conf.ini_file

conf.ini File

permissions.ini_file

The permissions.ini File

filter

The filter attribute of the fields.ini file

group

group directive in fields.ini file

encryption

encryption fields.ini file directive

modules

prefs