Xataface Wiki | Wiki

Creating_Printable_Reports

Field

Value

Page name

Creating_Printable_Reports

Page id

Page title

Creating a Custom Printable Report

Content

Creating a Printable Report

Table of Contents

Creating a Printable Report

It is often useful to provide your users with a printable report that is generated from your database. Although Xataface doesn't include an explicit reporting module to allow the end users to create their own

Language

http://xataface.com/documentation/how-to/site_with_backoffice_How_to_build_a_site_with_a_backoffice_

Field	Value
Page name	http://xataface.com/documentation/how-to/site_with_backoffice_How_to_build_a_site_with_a_backoffice_
Page id	84
Page title	A site with a backoffice
Content	A site with a backoffice To create a site with a backoffice for the administrator, so that the visitors do not have to log in to read the pages, you add this code in the ApplicationDelegate.php file in the conf directory : <code> function getPerm
Language	en

http://xataface.com/documentation/how-to/site_with_backoffice

Field	Value
Page name	http://xataface.com/documentation/how-to/site_with_backoffice
Page id	85
Page title	How to build a site with an optional login form
Content
Language	en

site_with_backoffice

Field	Value
Page name	site_with_backoffice
Page id	86
Content
Language	en

file

Field	Value
Page name	file
Page id	89
Content	Dynamic select boxes To create two select boxes whose one is dependent (slave) of the other (master), we need to use some javascript with Jason. Create the valuelists.ini: <code> valuelist for the slave [slaves_list] __sql__ = "select sla
Language	en

Dynamic_select_boxes

Field	Value
Page name	Dynamic_select_boxes
Page id	90
Content	Dynamic select boxes To create two select boxes whose one is dependent (slave) of the other (master), we need to use some javascript with Jason. Create the valuelists.ini: <code> valuelist for the slave [slaves_list] __sql__ = "select sla
Language	en

setSecurityFilters

Field	Value
Page name	setSecurityFilters
Page id	91
Page title	setSecurityFilter() method
Content	Example In the delegate class for the users table: `<?php class tables_users { function init(&$table){ if ( !isAdmin() ){ $table->setSecurityFilter(array('group_id'=>10)); } } }` Thi
Language	en

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

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

init

Field	Value
Page name	init
Page id	140
Page title	init() Delegate Class Method
Content	Synopsis This method is called once, just after the table is loaded for the first time. It allows you to specify initialization details, such as security filters. Note that it takes a single parameter: a Dataface_Table o
Language	en

Clean_the_html_for_the_export

Field	Value
Page name	Clean_the_html_for_the_export
Page id	178
Page title	Clean the HTML to export data
Content	Clean HTML tags and entities to export your data Override the display() of the field to strip the tags... but this would affect all parts of the application where the HTML fields are displayed. Create a grafted field, then override its display to
Language	en

test_page_34

Field	Value
Page name	test_page_34
Page id	177
Page title	Hello World
Content	Hello world
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

column:legend

Field	Value
Page name	column:legend
Page id	182
Language	en

advmultiselect

Field	Value
Page name	advmultiselect
Page id	183
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

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

before_authenticate

Field	Value
Page name	before_authenticate
Page id	102
Page title	before_authenticate hook
Content	Return to Application Delegate Class The before_authenticate hook is a method that can be defined in the Application Delegate Class which is called before the authentication step occurs on every request (not just on login). It is m
Keywords	authentication
Language	en

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

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

beforeHandleRequest

Field

Value

Page name

beforeHandleRequest

Page id

107

Page title

beforeHandleRequest Application Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

Synopsis

The beforeHandleRequest method is a very useful hook that can be implemented in an Application Delegate Class to perform some processing before every request.

This hook is c

Keywords

beforeHandleRequest, Application Delegate

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

calendar

Field

Value

Page name

calendar

Page id

100

Page title

Calendar Widget

Content

Back to widget:type

Table of Contents

Synopsis

The calendar widget is the default widget for editing date and datetime fields. It is javascript pop-up calendar that allows users to select date and time visually. It can be configured to allow di

Keywords

calendar widget, fields.ini file, widget:type

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

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

GettingStarted:delegate_classes

Field	Value
Page name	GettingStarted:delegate_classes
Page id	80
Page title	Delegate Classes
Content	Delegate Classes Use Delegate classes to add permissions, custom serialization, display filters, calculated fields, import/export functionality, and other custom functionality to your application. For many applications, the configuration files p
Keywords	delegate classes,getTitle,getPermissions
Language	en

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

getPasswordChangedEmailInfo

Field

Value

Page name

getPasswordChangedEmailInfo

Page id

121

Page title

getPasswordChangedEmailInfo Application Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

Synopsis

Optional method to define the settings for the email that is sent to the user upon successful resetting of their password using the password reset function.

Introduced in Xatafac

Keywords

forgot password, reset password

Language

getResetPasswordEmailInfo

Field

Value

Page name

getResetPasswordEmailInfo

Page id

122

Page title

getResetPasswordEmailInfo Application Delegate Class Method

Content

Return to Application Delegate Class

Table of Contents

Synopsis

Optional method to define the settings for the email that is sent to the user when they request to reset their password.

Introduced in Xataface 1.3. Exists in 1.3 or higher.

Keywords

forgot password, reset password

Language

GettingStarted:validation

Field	Value
Page name	GettingStarted:validation
Page id	79
Page title	Form Validation
Content	Form Validation Xataface allows you to add validation rules to fields using the fields.ini file A common requirement for forms is to have some validation rules. Here are some example validation rules: The Username field is required. The Us
Keywords	form validation,required field,validation rules
Language	en

Xataface Wiki | Wiki

Creating_Printable_Reports

Creating a Printable Report

http://xataface.com/documentation/how-to/site_with_backoffice_How_to_build_a_site_with_a_backoffice_

A site with a backoffice

http://xataface.com/documentation/how-to/site_with_backoffice

site_with_backoffice

file

Dynamic select boxes

Dynamic_select_boxes

Dynamic select boxes

setSecurityFilters

Example

meta:class

list:type

init

Synopsis

Clean_the_html_for_the_export

Clean HTML tags and entities to export your data

test_page_34

viewable_editable_fields

column:legend

advmultiselect

GettingStarted:using_first_app

Using Your First Application

afterCopy

Synopsis

before_authenticate

beforeAddRelatedRecord

Synopsis

beforeCopy

Synopsis

beforeHandleRequest

Synopsis

field__fieldname

calendar

Synopsis

reCAPTCHA_module

Synopsis

fieldname__default

Synopsis

GettingStarted:delegate_classes

Delegate Classes

documentation_guide

getPasswordChangedEmailInfo

Synopsis

getResetPasswordEmailInfo

Synopsis

GettingStarted:validation

Form Validation