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

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

_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

Introduction_to_the_Xataface_API

Field

Value

Page name

Introduction_to_the_Xataface_API

Page id

101

Page title

Introduction to the Xataface API

Content

Back to the wiki

Table of Contents

Synopsis

Xataface is provides an API to help in developing your own custom actions. This API includes objects and functions to more easily interact with the database (i.e. search, edit, d

Keywords

xataface api, df_get_record, df_get_records_array, Dataface_Record, Editing, Saving, Loading, Searching

Language

GettingStarted:customizing

Field	Value
Page name	GettingStarted:customizing
Page id	76
Page title	Customizing Field labels, descriptions, and widgets
Content	Customizing Field labels, descriptions, and widgets Using simple INI configuration files, you can customize the look and feel of your application. You can change widgets, labels, field descriptions, and more. In the previous 2 sections we learned
Keywords	widget labels descriptions onclick handlers
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

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

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

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

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

How_to_build_a_PHP_MySQL_Application_with_4_lines_of_code

Field

Value

Page name

How_to_build_a_PHP_MySQL_Application_with_4_lines_of_code

Page id

Page title

How to build a PHP MySQL Application with 4 lines of code

Content

The Xataface Application Framework allows you to convert your existing MySQL database into a full-fledged with as little as 4 lines of code. And it's Not a code generator.

Table of Contents

This article is intended to spark intere

Keywords

tutorial, getting started, installation, first app, 4 lines of code

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

beforeSave

Field

Value

Page name

beforeSave

Page id

109

Page title

beforeSave Trigger

Content

Back to Delegate class methods

Table of Contents

Synopsis

The beforeSave trigger can be implemented in any table's Delegate Class Methods? to perform functionality that should be run *before* a record of that table is saved.

Keywords

triggers, beforeSave,

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

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

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

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

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

Introduction_to_RSS_Feeds_in_Xataface

Field

Value

Page name

Introduction_to_RSS_Feeds_in_Xataface

Page id

Page title

Introduction_to_RSS_Feeds_in_Xataface

Content

Introduction to RSS Feeds in Xataface

Table of Contents

Introduction to RSS Feeds in Xataface

A default Xataface application provides RSS feeds to any found set in your application. This article explains a little bit about RSS and how you can configure Xataface to give you the desired result

Keywords

RSS Feeds

Language

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

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

GettingStarted:relationships

Field	Value
Page name	GettingStarted:relationships
Page id	78
Page title	Relationships
Content	Relationships Xataface allows you to define relationships between tables using the relationships.ini file. Xataface applications without relationships between tables can be quite boring. In our FacultyOfWidgetry application, we have implicitly d
Keywords	relationships
Language	en

after_action_activate

Field

Value

Page name

after_action_activate

Page id

181

Page title

after_action_activate Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

The after_action_activate hook is a method that can be defined in the Application Delegate Class which is called after an account has been activated via the registration process. The full

Keywords

Registration, activation, register, activate, users

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

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

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

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

Xataface Wiki | Wiki

sql_delegate_method

Synopsis

__global__

Synopsis

_auth

Synopsis

XataJax_Compiler

Synopsis

XataJax

Introduction_to_the_Xataface_API

Synopsis

GettingStarted:customizing

Customizing Field labels, descriptions, and widgets

GettingStarted:valuelists

Using Value-lists

valuelists.ini_file

valuelists.ini file Reference

validators

Synopsis

validators:VALIDATOR_NAME:message

Synopsis

fieldname__validate

Synopsis

URL_Conventions

Xataface URL Conventions

How_to_build_a_PHP_MySQL_Application_with_4_lines_of_code

GettingStarted:triggers

Triggers

beforeSave

Synopsis

Contribute_to_Xataface_Translation_Project

Synopsis

timestamp

xataface_templates

Xataface Templates

secure

Delegate_class_methods

Delegate Class Reference

Introduction_to_RSS_Feeds_in_Xataface

Introduction to RSS Feeds in Xataface

relationships.ini_file

relationships.ini File Reference

Overview

Relationship_Permissions

Synopsis

GettingStarted:relationships

Relationships

after_action_activate

registration_form

Synopsis

Using_RecordGrid

Xataface RecordGrid Class and Template

Introduction

field__pullValue

field__pushValue

global