Xataface Wiki | Wiki

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

_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

_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

XataJax_Compiler

Field

Value

Page name

XataJax_Compiler

Page id

114

Page title

Introduction to the XataJax Compiler

Content

Return to XataJax

DISCLAIMER: This page introduces features that require Xataface 1.3 or higher. At present (Jan. 2011) only Xataface 1.2.6 has been released to the public.

Table of Contents

Synopsis

The XataJax compiler is a Javascript

Keywords

XataJax, compiler, javascript, css, compiler

Language

XataJax

Field

Value

Page name

XataJax

Page id

113

Page title

Introduction to XataJax

Content

Table of Contents

Xataface 1.3 comes with a new module XataJax which comes installed standard. XataJax serves as a foundation for Javascript/AJAX powered Xataface applications and will hopefully usher in a new fresh generation of Xataface powered applic

Keywords

XataJax, Ajax, Web 2.0

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

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

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

viewable_editable_fields

Field	Value
Page name	viewable_editable_fields
Page id	180
Page title	How to make a field editable for some users and only viewable for some other users
Content	If we want only some users to edit a field and some other users only to view that field, then we need to define a fieldX__permissions() method for that field which gives desired permissions for specific users. One solution is as below. ==permi
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

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

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

test_page_34

Field	Value
Page name	test_page_34
Page id	177
Page title	Hello World
Content	Hello world
Language	en

testpage2

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

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

table

Field	Value
Page name	table
Page id	66
Page title	table
Content	When using widget:type table, it will store the data as XML. So the field type must be TEXT (or varchar... but text is better). You can decide which columns you want in the table by creating sub-fields in your fields.ini file as follows: Suppose you
Language	en

tab

Field

Value

Page name

tab

Page id

Page title

tab

Content

tab directive of the fields.ini file

Table of Contents

tab directive of the fields.ini file

The tab directive of the fields.ini file specifies which tab of the record edit form a field should be displayed on. Xataface supports multiple tabs on the edit form by way of this tab di

Language

struct

Field	Value
Page name	struct
Page id	56
Page title	struct
Language	en

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

Xataface Wiki | Wiki

__prefs__

__global__

Synopsis

__field__permissions

_output_cache

_auth

Synopsis

XataJax_Compiler

Synopsis

XataJax

xataface_templates

Xataface Templates

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

visibility:fieldName

Example

viewable_editable_fields

valuelists.ini_file

valuelists.ini file Reference

validators:VALIDATOR_NAME:message

Synopsis

validators

Synopsis

validateRegistrationForm

validateRegistrationForm() hook

Signature

Parameters

Using_RecordGrid

Xataface RecordGrid Class and Template

Introduction

URL_Conventions

Xataface URL Conventions

Troubleshooting

Xataface Troubleshooting

All I get is a blank white screen!

timestamp

test_page_34

testpage2

templates:tags:use_macro

use_macro Template Tag

Synopsis

Parameters

table

tab

tab directive of the fields.ini file

struct

sql_delegate_method

Synopsis

prefs

global

fieldpermissions