Xataface Documentation

Getting Started

Please read the following tutorial(s) to help you get acquainted with the framework.

Getting Started with Xataface
This introductory tutorial discusses why you might want to use Xataface, then goes on to show you how to create your own Xataface application in under 20 minutes.

Reference

INI File and Delegate Class Reference
A list with descriptions of the available ini file directives (fields.ini, valuelists.ini, etc..). Also a list with descriptions of available delegate class methods.
Xataface API Docs
API documentation for the classes, methods, and functions that comprise the Web Lite framework.

Tutorials

What's new in Xataface 0.7
Dataface 0.7 comes with loads of new features. This tutorial provides a glance at these features and some instructions on how to use them.
Getting Started with Web Auction
This tutorial describes what Web Auction is, and how you can use it to set up your own online auction.
How to build submission forms using Xataface
A submission form (a form for users to submit information into a database) is a very common use-case for Xataface. This tutorial teaches you how to do it the right way.
Internationalization with Xataface
Xataface includes the ability to internationalize your applications. Note, that multilingualization of content requires the query translation extension that is not available as open-source. Contact info at weblite.ca for more information about
Getting Started with Xataface
Web Lite is a simple framework for developing data-driven web applications in PHP and MySQL. This tutorial will show you how to get a dataface powered web application running in under 20 minutes.
Customizing the Web Lite Look and Feel
The Xataface includes some powerful templating tools that give the developer the power to modify any part of the interface easily.
Getting Started with Dataface 0.5.x
Dataface is a simple framework for developing data-driven web applications in PHP and MySQL. This tutorial will show you how to get a dataface powered web application running in under 20 minutes.

How-tos

How to Customize the View Tab
This document explains how you can customize the view tab.
How to disable the Enter key in forms.
This function ignores the Enter key while editing or adding new records. This is useful when using barcode scanners to enter data or simply to avoid incomplete form submissions. Tested with Mac Firefox, Safari and IE.
How to disallow access to tables
Xataface 0.7 adds the ability to prevent access to certain tables of your database via the _disallowed_tables section of the conf.ini file.
How to customize the date format in a delegate class
This how-to is aimed at changing the date format inside the date fields when creating or modifying a record.
Removing appended port numbers
How to remove the additional port number appended to the Dataface url upon form submission.
Configuring and Customizing the List Tab
This document explains how to customize the display of the list tab using INI files, templates, and delegate classes.
How to add user registration to your application
Xataface 0.7.4 includes built-in support for user registration. This document explains how to activate it along with some usage examples.
Creating User Spaces
Use MySQL temporary tables to create user spaces so that different users have access to different records.
How to internationalize your application
Xataface 0.6 contains a LanguageTool class that allows your applications to be presented in multiple languages
How to use other translations
Xataface 0.7 includes German and French translations. This document explains how to allow your application to use these and other translations, rather than the default English translation.
How to write an import filter to import records into a table or relationship
It is common to need to import records en masse into a database. This is what import filters are for. (Since 0.7)
How to use Security filters to hide records from certain users
Use security filters to block users from seeing certain records.
Adding triggers to actions
Xataface 0.6.1 adds some triggers to actions so that the developer can define custom functionality to be performed after an action has successfullly taken place.
How to include custom javascripts and stylesheets in your application
Use the custom_javascripts and custom_stylesheets blocks to include your own custom javascript and CSS files in your application.
How to enable unicode support
As of Xataface 0.6, unicode is fully supported so that your dataface application will work with any and multiple languages simultaneously.
How to activate history logging
Xataface 0.6.9 comes with support for managing the history of your records. This how-to shows you how to enable and use this feature.
How to use views
MySQL 5 supports Views. This how-to describes how to use one of these Views in Dataface
How to add calculated fields to your list and details view
Sometimes it may be desirable to show data in the list and details view that is not actually stored in the record. This how-to shows how you can do this in Dataface 0.6.3.
How to hide the search box
The full-text search box that appears in the upper right can easily be removed.
How to assign order to related records
Sometimes it is desirable for the records in a relationship to take on a particular default order. Dataface 0.6 makes this easy if you follow a few conventions.
How to make fields display inline
By default Xataface lays out its forms so that the fields are easy displayed on their own line. This how-to explains how to make certain fields show up on the same line.
How to define custom serialization for fields
Xataface allows you to define your own serializers and parsers for fields so that you can store arbitrarily formatted content in your database and manage how it is edited and displayed in your application.
How to handle file uploads
Xataface allows you to store file uploads in BLOB fields or on the file system.
How to customize the Xataface look and feel with Smarty Templates
Most of the Xataface look and feel is the result of Smarty templates and CSS style sheets. These can be overridden and customized very easily.
How to add custom validation with Delegate Classes
If the standard validators (e.g., required, email, regex, etc..) don't quite cut it for your validation rules, Xataface allows you to define custom validation methods in the delegate class.
How to change the default action (e.g., to list view)
Xataface automatically shows the 'details' tab if no other action is specified. This how-to explains how to change this default functionality to make the 'list' tab the default view.
Validating with regular expressions
How to validate input into a field using regular expressions
Powered by Dataface
(c) 2005-2007 All rights reserved