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

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

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

prefs

__prefs__

Field	Value
Page name	__prefs__
Page id	9
Page title	__prefs__
Content
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

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

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

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

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

ShoppingCart

Field

Value

Page name

ShoppingCart

Page id

Page title

ShoppingCart

Content

Xataface Shopping Cart Module

Table of Contents

Xataface Shopping Cart Module

Synopsis

Status: Under development Current Version: 0.2

Synopsis

Add a shopping cart to your xataface application. You can treat any record as a product that can be sold. Includes Paypal connectivity,

Language

DataGrid

Field	Value
Page name	DataGrid
Page id	32
Page title	DataGrid
Content	Xataface DataGrid Module Created by Steve Hannah, Web Lite Solutions Corp. Synopsis The Xataface DataGrid module uses the Ext DataGrid component (http://extjs.com) to add an editable grid component to your Xataface a
Language	en

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

widget:editor

Field

Value

Page name

widget:editor

Page id

Page title

widget:editor

Content

widget:editor fields.ini directive

Return to fields.ini file

Table of Contents

widget:editor fields.ini directive

The widget:editor directive is applicable in the fields.ini file. It specifies the type of HTML editor that should be used. This directive is only used when [[widg

Language

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

Drag_and_Drop_Reordering_of_Relationships

Field	Value
Page name	Drag_and_Drop_Reordering_of_Relationships
Page id	39
Page title	Drag_and_Drop_Reordering_of_Relationships
Content	Drag and Drop Reordering of Related Records in Xataface One powerful aspect of Xataface is its abstraction of relationships between tables. Once you define a relationship users can browse related records, add new and existing related records, and
Language	en

getFeedItem

Field

Value

Page name

getFeedItem

Page id

Page title

getFeedItem

Content

getFeedItem() Delegate Class Method

Table of Contents

getFeedItem() Delegate Class Method

Synopsis:

The getFeedItem() method of a table delegate class returns an associative array of parameters for a record as it should appear as part of an [[Introduction

Language

getFeed

Field

Value

Page name

getFeed

Page id

Page title

getFeed

Content

getFeed() Delegate Class Method

Table of Contents

getFeed() Delegate Class Method

Synopsis:

The getFeed() method of a table delegate class or application delegate class returns an associative array of parameters to confi

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

widget:atts

Field	Value
Page name	widget:atts
Page id	46
Page title	widget:atts
Content	widget:atts Directive Reference The widget:atts directive in the fields.ini file allows any arbitrary HTML attributes to be added to any of the fields. It may also be used to specify javascript event handler functions that the widget should call u
Language	en

visibility:fieldName

Field	Value
Page name	visibility:fieldName
Page id	47
Page title	visibility:fieldName
Content	Example `visibility:ConferenceID = hidden` This will make the ConferenceID in the relationship list view disappear.
Language	en

Xataface Wiki | Wiki

index_page

Documentation

Introductory

testpage2

widget:type

widget:type Directive Reference

actions.ini_file

actions.ini file Reference

__prefs__

block__blockname

Available Blocks

beforeRegister

beforeRegister() Trigger

afterRegister

afterRegister() Trigger

validateRegistrationForm

validateRegistrationForm() hook

Signature

Parameters

sendRegistrationActivationEmail

sendRegistrationActivationEmail() Hook

Signature

getRegistrationActivationEmailInfo

getRegistrationActivationEmailInfo() Hook

getRegistrationActivationEmailSubject

getRegistrationActivationEmailSubject() Hook

getRegistrationActivationEmailMessage

getRegistrationActivationEmailSubject() Hook

Writing_Custom_Authentication_Plugins

Writing a Custom Authentication Plugin for Xataface

templates:tags:use_macro

use_macro Template Tag

Synopsis

Parameters

conf.ini_file

conf.ini File

filter

The filter attribute of the fields.ini file

group

group directive in fields.ini file

encryption

encryption fields.ini file directive

ShoppingCart

Xataface Shopping Cart Module

Synopsis

DataGrid

Xataface DataGrid Module

Synopsis

after_action_new

after_action_new trigger

widget:editor

widget:editor fields.ini directive

about

About Xataface

Drag_and_Drop_Reordering_of_Relationships

Drag and Drop Reordering of Related Records in Xataface

getFeedItem

getFeedItem() Delegate Class Method

Synopsis:

getFeed

getFeed() Delegate Class Method

Synopsis:

Calendar_Action

Calendar Action

widget:atts

widget:atts Directive Reference

visibility:fieldName

Example

prefs