Xataface Wiki | Wiki

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

loginFailed

Field

Value

Page name

loginFailed

Page id

184

Page title

loginFailed() Application Delegate Trigger

Content

Table of Contents

Example

The loginFailed() method of the Application Delegate class is executed after a failed login attempt.

Available since 2.0.1

Example

<code> function loginFailed($username, $userIp, $time){ error_log("Failed login for user

Keywords

Language

field__pushValue

Field

Value

Page name

field__pushValue

Page id

105

Content

Table of Contents

The field__pushValue() delegate class method can be used to transform a field value as entered in the edit form into a format that can be stored in the database.. Sometimes it is the case that we want users to be able to work with data differe

Keywords

pullValue, pushValue

Language

field__pullValue

Field

Value

Page name

field__pullValue

Page id

104

Page title

field__pullValue delegate class method

Content

Table of Contents

The field__pullValue() delegate class method can be used to transform database from the database for use in an edit/new record form. Sometimes it is the case that we want users to be able to work with data differently than it is stored in the

Keywords

pushValue, pullValue

Language

Module_Developers_Guide

Field

Value

Page name

Module_Developers_Guide

Page id

112

Page title

Module Developers Guide

Content

Table of Contents

Why Write a Xataface Module?

Xataface modules are components that can be used to extend Xataface's functionality in a generic way so that it can be used on multiple applications. If you find yourself trying to add the same functionality

Keywords

modules

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

Relationship_Permissions

Field

Value

Page name

Relationship_Permissions

Page id

111

Page title

Relationship Permissions

Content

Table of Contents

Synopsis

As relationships are a core feature of Xataface, it is helpful to understand how to handle permissions on related records. Even if you apply permissions to every table individually, you need to take into account the relationshi

Keywords

relationships, permissions, rel_relationshipname__permissions, getPermissions, permissions.ini

Language

registration_form

Field

Value

Page name

registration_form

Page id

Page title

Setting up User Registration

Content

Table of Contents

Synopsis

Xataface optionally enables you to allow users to register for an account in your application. If your users table includes a column for email, it will also perform email validation before the account is activated. Befor

Keywords

registration form, _auth, authentication

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

secure

Field	Value
Page name	secure
Page id	88
Page title	secure fields.ini directive
Content	fields.ini file directive used only with container fields?. If this flag is set, then the field contents will be treated in a secure manner and will obey the application permissions. If this directive is not set, then uploaded files in [[containe
Keywords	secure,fields.ini file
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

documentation_guide

Field	Value
Page name	documentation_guide
Page id	70
Page title	Documentation Guide
Content	Xataface uses a wiki to manage its online documentation which can be edited by anyone. All you have to do is login with your forum username and password ([http://xataface.com/forum/profile.php?mode=regis
Keywords	documentation wiki
Language	en

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

GettingStarted:Introduction

Field	Value
Page name	GettingStarted:Introduction
Page id	71
Page title	Introduction
Content	Web Lite is a simple framework for building data-driven web applications in PHP and MySQL. This section introduces some of the concepts and applications of Dataface. To fully understand what Xataface is, we must first define a few key terms: '''Fram
Keywords	introduction requirements getting started
Language	en

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

Key

Field	Value
Page name	Key
Page id	83
Page title	fields.ini Directive: Key
Content	The Key directive is used only when the table is a view and you need to explicitly define which columns are part of the primary key. For example, if we created a view on the books table to only show books in a given year as follows: <code> create
Keywords	Key, Views, MySQL Views, Create View, PRI, Primary Keys
Language	en

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

list:type

Field

Value

Page name

list:type

Page id

128

Page title

list:type relationships.ini file directive

Content

Return to relationships.ini file

Table of Contents

The list:type directive allows you to override the default list that is used to display related records. As of Xataface 1.3 there is only one possible value that will have any effect on this directive: "

Language

meta:class

Field

Value

Page name

meta:class

Page id

127

Page title

meta:class relationships.ini file directive

Content

Return to relationships.ini file

Table of Contents

The meta:class directive allows you to ascribe special meaning to a relationship which Xataface can use in various parts of your application to provide enhanced capabilities.

For example you can sp

Language

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

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

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

getChildren

Field

Value

Page name

getChildren

Page id

126

Page title

getChildren Delegate Class Method

Content

Return to Delegate class methods

Table of Contents

The getChildren() method can be implemented in a table's delegate class to specify the logical "child" records of a given record which can be used when creating hierarchical applications. This method wil

Keywords

getChildren Delegate class method

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

fieldname__default

Field

Value

Page name

fieldname__default

Page id

133

Page title

fieldname__default Delegate Class Method

Content

Return to Delegate class methods

Table of Contents

Synopsis

Xataface allows you to pre-populate any particular field in a table by adding a fieldname__default method to the table's delegate class of the form: <code> function fieldname__default(

Keywords

default, initialize, populate, pre-populate, delegate class default

Language

fieldname__validate

Field

Value

Page name

fieldname__validate

Page id

Page title

fieldname__validate Delegate Class Method

Content

Return to Delegate class methods

Table of Contents

Synopsis

Xataface allows you to add validation on any particular field in table by adding a fieldname__validate method to the table's delegate class of the form: <code> function myfield__valida

Keywords

validate, validation, delegate class validation, custom validator

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

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

field__fieldname

Field	Value
Page name	field__fieldname
Page id	141
Page title	Defining Calculated Fields
Content	Return to Delegate class methods Xataface allows you to define calculated fields using the delegate class. These fields won't be visible in the UI by default, but they will be accessible to some modules (e.g. the HTML Reports Module) and they are
Keywords	calculated fields, field__fieldname
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