Xataface Wiki | Wiki

sql_delegate_method

Field	Value
Page name	sql_delegate_method
Page id	87
Page title	__sql__ Delegate Method
Content	return to Delegate class methods Synopsis The __sql__ delegate class method can be defined in any delegate class to specify the SQL query that should be used to fetch records for a given table. This method overrides the __sql__? direct
Keywords	__sql__, SQL queries, delegate class
Language	en

prefs

__prefs__

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

global

__global__

Field

Value

Page name

__global__

Page id

106

Page title

__global__ section for the fields.ini file

Content

Return to fields.ini file

Table of Contents

Synopsis

The fields.ini file supports a __global__ section that applies to all fields in the current table. This is particularly useful for setting up default functionality that you wish to see on all

Keywords

__global__, fields.ini, visibility:list

Language

fieldpermissions

__field__permissions

Field	Value
Page name	__field__permissions
Page id	50
Page title	__field__permissions
Content	This method can be used to set the default permissions for all fields in a designated table, when specified in that table's delegate class. It comes in handy in situations when you want to deny access to all fields except for those designated, rather then
Language	en

_auth

Field

Value

Page name

_auth

Page id

Page title

_auth section of the conf.ini file

Content

Return to conf.ini file

Table of Contents

Synopsis

The _auth section of the conf.ini file includes configuration directives to enable authentication in a Xataface application. For more information about authentication and regis

Keywords

_auth,authentication,conf.ini file,allow_register

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

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

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

widget:type_textarea

Field	Value
Page name	widget:type_textarea
Page id	60
Page title	widget:type_textarea
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

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

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

GettingStarted:Why_Use_Xataface

Field	Value
Page name	GettingStarted:Why_Use_Xataface
Page id	72
Page title	Why Use Xataface
Content	Why Use Xataface? Some simple examples similar to those that are frequently encountered by web developers, and how dataface can be used to acheive a solution. As a web services developer in the Faculty of Applied Sciences at Simon Fraser Universit
Keywords	introduction motivation why
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

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

validators:VALIDATOR_NAME:message

Field

Value

Page name

validators:VALIDATOR_NAME:message

Page id

Page title

validators:VALIDATOR_NAME:message directive for the fields.ini file

Content

Return to fields.ini file

Table of Contents

Synopsis

If you want to customize the error message associated with a particular validation rule? you can use the validators:VALIDATOR_NAME:message directive in the fields.ini file.

===F

Keywords

validation messages,error messages,form validation rules

Language

validators

Field

Value

Page name

validators

Page id

Page title

validators:NAME fields.ini directive

Content

Return to fields.ini file

Table of Contents

Synopsis

In the fields.ini file you can specify validation rules to be applied to any field by adding the validators:NAME directive in that field's section of the fields.ini file.

===Available Va

Keywords

validation, form validation, validators,validator:name

Language

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

GettingStarted:using_first_app

Field	Value
Page name	GettingStarted:using_first_app
Page id	75
Page title	Using Your First Application
Content	Using Your First Application A Web Lite application, at its core, provides 4 standard operations: Add new records, edit existing records, delete records, and find records. This section gives a brief overview of how to use your first Dataface applic
Keywords	"find form","edit form","delete record","user interface",ui,template,look and feel
Language	en

GettingStarted:valuelists

Field	Value
Page name	GettingStarted:valuelists
Page id	77
Page title	Using Valuelists
Content	Using Value-lists Value-lists serve as vocabularies that can be used for fields such as select lists, checkbox groups, and auto-complete fields. So far we have not used any enumerated fields such as select lists, checkbox groups, or auto-complet
Keywords	valuelists, __sql__, select lists, checkbox options,checkbox groups,vocabularies
Language	en

Using_RecordGrid

Field

Value

Page name

Using_RecordGrid

Page id

115

Page title

Using RecordGrid

Content

Xataface RecordGrid Class and Template

Also see RecordGrid in the API Doc.

Table of Contents

Xataface RecordGrid Class and Template

Introduction

As we learned in '''[http://xat

Keywords

RecordGrid, Dataface_RecordGrid, data in tabular form

Language

URL_Conventions

Field

Value

Page name

URL_Conventions

Page id

Page title

URL_Conventions

Content

Xataface URL Conventions

Table of Contents

Xataface URL Conventions

Xataface adheres to a few simple URL conventions for all of its actions. When you understand how Xataface URLs work you begin to get far more out of your applications. By specifying the appropriate query parame

Keywords

URL Conventions, GET Parameters, POST parameters, Request Parameters

Language

Troubleshooting

Field

Value

Page name

Troubleshooting

Page id

Page title

Troubleshooting

Content

Xataface Troubleshooting

This document is intended to help Xataface developers through some of the most common issues.

Table of Contents

Xataface Troubleshooting

All I get is a blank white screen!

The most common issue mentioned in the forums is that an application come

Language

GettingStarted:triggers

Field	Value
Page name	GettingStarted:triggers
Page id	81
Page title	Triggers
Content	Triggers Triggers are methods that can be defined to carry out custom behaviors when certain events occur in the application (e.g., when records are saved, inserted, or deleted). Triggers are generally regarded as one of the more advanced featur
Keywords	triggers, beforeSave, afterSave, beforeInsert, afterInsert,sending email
Language	en

timestamp

Field	Value
Page name	timestamp
Page id	44
Page title	timestamp
Content	Return to fields.ini file A very simple sample of this could be your table contains the table date_created as a type of date. In your fields.ini, you would include this: `[date_created] timestamp=insert widget:type=hidden` T
Keywords	timestamp, date, datetime
Language	en

_output_cache

Field	Value
Page name	_output_cache
Page id	45
Page title	The Xataface Output Cache
Content	<nowiki><div class="portalMessage">Note: There was a bug in the output cache affecting Xataface version 1.0 to 1.3rc1. If you are using a version of Xataface older than 1.3rc2 then you should either disable the output cache, or replace the Dataface/Outpu
Keywords	output cache
Language	en

relationship

Field

Value

Page name

relationship

Page id

Page title

The relationship fields.ini directive

Content

Return to fields.ini file directives

Table of Contents

Synopsis

Certain types of widgets (e.g. grid (v1.0) and checkbox (v1.2)) support the relationship directive which allows them to effectively add/remove records from a specifie

Keywords

grid widget, relationship, checkbox

Language

reCAPTCHA_module

Field

Value

Page name

reCAPTCHA_module

Page id

Page title

The reCAPTCHA module

Content

Table of Contents

Synopsis

The Xataface reCAPTCHA module CAPTCHA support to any Xataface form that is rendered to the public (i.e. when users are not logged in). This is particularly useful for the registration form as a means of spam prevention.

Keywords

captcha, registration, validation

Language

lookup

Field

Value

Page name

lookup

Page id

Page title

The Lookup Widget

Content

Return to widget:type page to see list of all widget types. Back to fields.ini file to see other fields.ini directives.

Table of Contents

Synopsis

The lookup widget allows users to look a record from another table to insert into the field.

Keywords

lookup widget, widget:filters, widget:-filters:limit, widget:table

Language

testpage2

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

Xataface Wiki | Wiki

sql_delegate_method

Synopsis

__prefs__

__global__

Synopsis

__field__permissions

_auth

Synopsis

xataface_templates

Xataface Templates

modules

Writing_Custom_Authentication_Plugins

Writing a Custom Authentication Plugin for Xataface

widget:type_textarea

widget:type

widget:type Directive Reference

widget:editor

widget:editor fields.ini directive

widget:atts

widget:atts Directive Reference

GettingStarted:Why_Use_Xataface

Why Use Xataface?

visibility:fieldName

Example

valuelists.ini_file

valuelists.ini file Reference

validators:VALIDATOR_NAME:message

Synopsis

validators

Synopsis

validateRegistrationForm

validateRegistrationForm() hook

Signature

Parameters

GettingStarted:using_first_app

Using Your First Application

GettingStarted:valuelists

Using Value-lists

Using_RecordGrid

Xataface RecordGrid Class and Template

Introduction

URL_Conventions

Xataface URL Conventions

Troubleshooting

Xataface Troubleshooting

All I get is a blank white screen!

GettingStarted:triggers

Triggers

timestamp

_output_cache

relationship

Synopsis

reCAPTCHA_module

Synopsis

lookup

Synopsis

testpage2

prefs

global

fieldpermissions