timestamp 44 timestamp 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: <code> [date_created] timestamp=insert widget:type=hidden </code> The widget:type=hidden will make the field not visible during entry and editing. And the timestamp=insert causes the field to be filled upon insertion of a new record. ===Possible Values=== * '''update''' - Causes timestamp to be updated whenever the record is modified. * '''insert''' - Causes the timestamp to be updated only when the record is first inserted. timestamp, date, datetime en 0 getChildren 126 getChildren Delegate Class Method Return to [[Delegate class methods]] [[toc]] 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 will effectively override the output of the Dataface_Record::getChildren() method for records of this table. ===Signature=== <code> function getChildren( Dataface_Record $record) : Dataface_Record[] </code> ===Parameters=== # '''$record''' - The Dataface_Record that is the subject of the query ===Returns=== This method should return an array of Dataface_Record objects that are considered to be children of the subject record. ===Examples=== <code> function getChildren($record){ return df_get_records('webpages', array( 'parent_id'=>'='.$record->val('webpage_id') ) ); } </code> ==See Also== * '''[[getParent]]''' - A Delegate class method to return the logical parent of a given record. getChildren Delegate class method en beforeAddRelatedRecord 108 beforeAddRelatedRecord Delegate Class Method Return to [[Delegate class methods]] [[toc]] ==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. Since it will be fired for all relationships on the table, you will have to include logic to only execute if the relationship that you are targeting is being added to. ==Method Signature== <code> function beforeAddRelatedRecord( Dataface_RelatedRecord $record ); </code> ==Parameters== * '''$record''' - The [http://dataface.weblite.ca/Dataface_RelatedRecord Dataface_RelatedRecord] object encapsulating the record that is being added to the relationship. ===Returns=== * void - If all is well * [http://dataface.weblite.ca/Dataface_Error Dataface_Error] object if something went wrong. It is quite common to return a permission denied error from this method after doing some checks. e.g. <code> function beforeAddRelatedRecord($record){ if ( /* some checks here */ ){ return Dataface_Error::permissionDenied('Sorry you don\'t have permission to do this.'); } } </code> ==Examples== ===Example 1: Permission Check=== <code> function beforeAddRelatedRecord($record){ if ( $record->_relationshipName == 'program_roles' ){ // check to make sure that we are allowed to add roles to this program $program = df_get_record('programs', array('program_id'=>'='.$record->val('program_id'))); if ( !$program ){ return Dataface_Error::permissionDenied("Program could not be found"); } if ( !$program->checkPermission('add new related record', array( 'relationship' => 'program_roles' ) ) ){ return Dataface_Error::permissionDenied("You don't have permission to add roles to this program"); } } } </code> The above example requires a little bit of context to understand. This method is defined in the 'users' table. There is a relationship between the ''users'' table and the ''programs'' table called 'program_roles'. It keeps track of the roles that users have with respect to programs. There is a mirror relationshp in the ''programs'' table that goes to the ''users'' table, also named ''program_roles''. Both the ''users'' table and the ''programs'' table contain rel_program_roles__roles() methods to define who can and cannot add to this relationship. However these don't discern on the content that is being added to the relationship, so it is still possible that an ineligible program could be added to the relationship via the users table (or vice versa). So, in the ''users'' table we defined the ''beforeAddRelatedRecord'' above which checks the permissions of the programs table to see if that particular program can be added to this relationship by this user. ==See Also== * [http://dataface.weblite.ca/Dataface_RelatedRecord Dataface_RelatedRecord API Docs] * [[Delegate class methods]] * [http://xataface.com/documentation/tutorial/getting_started/relationships Introduction to Relationships] - from the Getting Started Tutorial * [[relationships.ini file]] reference beforeAddRelatedRecord, Delegate class methods, relationship triggers en fieldname__default 133 fieldname__default Delegate Class Method Return to [[Delegate class methods]] [[toc]] ===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(){ return value; }</code> Returns the default value for the field fieldname. New record forms will be prepopulated with this value. ===Examples=== <code> function minimum_bid__default(){ return 100; }</code> <code> function mydatecol__default(){ return date('Y-m-d'); }</code> <code> function owner_id__default(){ $auth =& Dataface_AuthenticationTool::getInstance(); $user =& $auth->getLoggedInUser(); if ( isset($user) ) return $user->val('userid'); return null; }</code> ===See Also=== * [http://xataface.com/forum/viewtopic.php?t=5028 Pre-entered Data] (forum thread) - setting defaults field values on general fields using the fieldname__default delegate class function * [http://xataface.com/forum/viewtopic.php?t=4004 How to initialize a Date field to today's date?] (forum thread) - alternate methods to use specifically with a date/time field * [http://xataface.com/forum/viewtopic.php?t=3988 Setting default select setting from users table] (forum thread) - solution to populate the current user default, initialize, populate, pre-populate, delegate class default en fieldname__validate 94 fieldname__validate Delegate Class Method Return to [[Delegate class methods]] [[toc]] ===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__validate(&$record, $value, &$params){ if ( $value != 'Steve' ){ $params['message'] = 'Sorry you must enter "Steve"'; return false; } return true; } </code> ===Parameters=== * &$record : A [http://dataface.weblite.ca/Dataface_Record Dataface_Record] object encapsulating the record we are validating. Note that the values of this object correspond with the submitted values from the form, and not necessarily the actual values of the record in the database. * $value : The value that is being inserted. * &$params : An output array that can be used to pass back a message if validation fails. You would set this array's 'message' parameter to be a message. ===Returns=== Returns a boolean value. True if the value is ok and false if validation failed. ===See Also=== * [[validators]] - For simple validation rules you can use the [[validators|validator:VALIDATOR_NAME]] directive of the [[fields.ini file]]. * [http://xataface.com/documentation/tutorial/getting_started/validation Form Validation] - Section on form validation in the Getting Started tutorial. validate, validation, delegate class validation, custom validator en beforeCopy 124 beforeCopy Delegate Class Method Return to [[Delegate class methods]] [[toc]] ===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 are not copied by default. If you want a more complex copy function for a table you can implement functionality in this hook. Available since version 1.3 ===Signature=== <code> function beforeCopy( Dataface_Record $original, array $values); </code> ===Parameters=== * '''$original''' - The original record that is to be copied. * '''$values''' - Associative array of values that are meant to be changed in the copy. Keys correspond with column names. ===Returns=== * Either return nothing or you may return a PEAR_Error object to indicate that an error occurred with the copy. ==See Also== * [[afterCopy]] - The afterCopy hook that can be implemented in the delegate class to run just after a record is copied. beforeCopy, copy records en afterCopy 123 afterCopy Delegate class Method Return to [[Delegate class methods]] [[toc]] ===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 not copied by default. If you want a more complex copy function for a table you can implement functionality in this hook. Available since version 1.3 ===Signature=== <code> function afterCopy( Dataface_Record $original, Dataface_Record $copy); </code> ===Parameters=== * '''$original''' - The original record that was copied. * '''$copy''' - The resulting copied record. ===Returns=== * Either return nothing or you may return a PEAR_Error object to indicate that an error occurred with the copy. ==See Also== * [[beforeCopy]] - The beforeCopy hook that can be implemented in the delegate class to run just before a record is copied. afterCopy, copy record hook en field__fieldname 141 Defining Calculated Fields 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 always accessible to you via the API. E.g. If you define a calculated field named ''year'', you would be able to access this value using the regular Dataface_Record syntax: <code> $record->val('year'); </code> You could also define any number of filter methods and permissions on this field just as you can on regular fields. e.g. <code> function year__permissions($record){ // Return special permissions on the year field. } </code> or <code> function year__display($record){ // Override how the year is displayed in the UI. return $record->val('year').' A.D.'; } </code> ==How to Define a Calculated Field== In the delegate class you simply create a method with the following naming convention: <code> function field__fieldname(Dataface_Record $record); </code> where the return value is the value that the given record should have for the field ''filedname''. E.g. <code> function field__year($record){ $time = trtotime($record->strval('date')); if ( $time ){ return date('Y', $time)); } else { return ''; } } </code> calculated fields, field__fieldname en sql_delegate_method 87 __sql__ Delegate Method 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__]] directive of the fields.ini file. This strategy is primarily used to graft columns from another table onto the base table. =====Use Caution===== This is an advanced feature and, if used incorrectly, can muck up your application. Make sure that your SQL query includes a superset of the columns in the base table, and is a row-for-row match for the rows in the base table. I.e. you should never use an internal join. Always use a left join so that all of the rows of the base table are returned even if the join table doesn't have a corresponding row. If you want to simply filter a table's records, and don't need to graft any additional columns onto the table, you should use the [[setSecurityFilters]] method. ===Example=== Given the table foo, its delegate class: <code> class tables_foo { function __sql__(){ return "select f.*, c.category_name from foo f left join categories c on f.category_id=c.category_id"; } } </code> This effectively grafts a column "category_name" onto the foo table based on a join with the categories table. __sql__, SQL queries, delegate class en Authenticating_Against_the_PHPBB_Users_table 92 Authenticating Against the PHPBB Users Table Return to [[authentication]] [[toc]] Xataface is able to use the PHPBB 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 PHPBB message forum. Achieving this level of integration requires 2 simple steps: # Set up the [[_auth]] section of your [[conf.ini file]] to reference the PHPBB users table and the correct username and password columns. # Specify the correct encryption on the password column. This step will be different for different versions of PHPBB. ==PHPBB 2== PHPBB version 2 and lower simply use MD5 encryption on the password column, which Xataface supports natively via the [[encryption]] directive of the [[fields.ini file]]. Therefore we can set up our Xataface application to authenticate against our PHPBB2 database ('''assuming that our PHPBB is set up in the same database as our Xataface app''') by doing the following: # Set up the [_auth] section of the [[conf.ini file]] as follows:<code> [_auth] users_table = phpbb_users username_column = username password_column = user_password </code> # Set up the user_password field to use md5 encryption in the ''tables/phpbb_users/fields.ini'' file <code> [user_password] encryption=md5 </code> That's it! Now you should be able to log into your Xataface application using the username/password from PHPBB. ==PHPBB 3== PHPBB version 3 and higher uses a custom encryption function for the password column so it is a little more complicated (but not that much). Step one (the [[conf.ini file]]) is the same as for PHPBB version 2 listed above. The 2nd part, however, requires us to implement a custom serialization for the user_password field. So the steps are below: # Set up the [_auth] section of the [[conf.ini file]] as follows:<code> [_auth] users_table = phpbb_users username_column = username password_column = user_password </code> # Implement the user_password__serialize() method in your phpbb_users delegate class (i.e. the ''tables/phpbb_users/phpbb_users.php'' file):<code> <?php class tables_phpbb_users { function user_password__serialize($password){ $itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'; $sql = "select user_password from phpbb_users where username='".addslashes($_POST['UserName'])."'"; $res = mysql_query($sql, df_db()); if ( !$res ) throw new Exception(mysql_error(df_db())); $row = mysql_fetch_assoc($res); mysql_free_result($res); $hash = $this->_hash_crypt_private($password, $row['user_password'], $itoa64); return $hash; } /** * The crypt function/replacement */ function _hash_crypt_private($password, $setting, &$itoa64) { $output = '*'; // Check for correct hash if (substr($setting, 0, 3) != '$H$') { return $output; } $count_log2 = strpos($itoa64, $setting[3]); if ($count_log2 < 7 || $count_log2 > 30) { return $output; } $count = 1 << $count_log2; $salt = substr($setting, 4, 8); if (strlen($salt) != 8) { return $output; } /** * We're kind of forced to use MD5 here since it's the only * cryptographic primitive available in all versions of PHP * currently in use. To implement our own low-level crypto * in PHP would result in much worse performance and * consequently in lower iteration counts and hashes that are * quicker to crack (by non-PHP code). */ if (PHP_VERSION >= 5) { $hash = md5($salt . $password, true); do { $hash = md5($hash . $password, true); } while (--$count); } else { $hash = pack('H*', md5($salt . $password)); do { $hash = pack('H*', md5($hash . $password)); } while (--$count); } $output = substr($setting, 0, 12); $output .= $this->_hash_encode64($hash, 16, $itoa64); return $output; } /** * Encode hash */ function _hash_encode64($input, $count, &$itoa64) { $output = ''; $i = 0; do { $value = ord($input[$i++]); $output .= $itoa64[$value & 0x3f]; if ($i < $count) { $value |= ord($input[$i]) << 8; } $output .= $itoa64[($value >> 6) & 0x3f]; if ($i++ >= $count) { break; } if ($i < $count) { $value |= ord($input[$i]) << 16; } $output .= $itoa64[($value >> 12) & 0x3f]; if ($i++ >= $count) { break; } $output .= $itoa64[($value >> 18) & 0x3f]; } while ($i < $count); return $output; } } </code> PHPBB, authentication, security, authentication modules en getNavItem 125 getNavItem Application Delegate Class Method Return to [[Application Delegate Class]] [[toc]] ===Synopsis=== The getNavItem() method of the application delegate class can be used to override the items that appear in the navigation menu (i.e. the menu that allows users to select the table via either tabs along the top or items along the side). It should return an associative array with characteristics of the navigation item including the href (i.e. link), label, and selected status. Using this method it is now possible to have non-table navigation items as well. You would just add these items to the \[_tables\] section of the [[conf.ini file]] then override the item using this method. '''Since 1.3''' ====How the Nav Menu Is Built==== Xataface builds the navigation menu by looping through each item in the [_tables] section of the conf.ini file, passing it to the getNavItem() method, and adding the resulting navigation item to the menu. If getNavItem() returns null, then that item will be skipped. If getNavItem throws an exception, then the default rendering for the menu item will take place. ===Signature=== <code> function mixed getNavItem( string $key, string $label ) throws Exception </code> ===Parameters=== * '''$key''' - The key of the nav item. In the case of a table, this would be the table name. * '''$label''' - The label of the nav item (may be overridden). ===Returns=== This method should return either: # An associative array with the properties of the nav item. # null to indicate that this nav item should be omitted altogether. (e.g. if the user shouldn't have permission for it). If returning an associative array, it should contain the following keys: * '''href''' - (String) The URL where this nav item should point. * '''label''' - (String) The label of this nav item. * '''selected''' - (Boolean) True if the nav item is currently selected. False otherwise. ===Throws=== If you want to signal Xataface to just use default rendering for the current navigation item you can just throw an exception. The default rendering will link to the table named ''$key'', and the item's label will be the same as ''$label''. ==Examples== Given the following conf.ini file: <code> ... [_tables] people=People books=Books accounts=Accounts reports=Reports ... </code> Suppose we want the navigation menu to only show the ''people'' and ''books'' options for regular users. Admin users can see all options. In addition, the 'reports' option doesn't correspond with a table of the database. Instead we are just going to link it to a custom action named 'reports'. Our getNavItem() method will look something like this: <code> function getNavItem($key, $label){ if (!isAdmin() ){ switch ($key){ case 'people': case 'books': // non-admin users can see these throw new Exception("Use default rendering"); } // Non-admin users can't see any other table. return null; } else { //Admin users can see everything.. $query =& Dataface_Application::getInstance()->getQuery(); switch ($key){ case 'reports': // reports is not a table so we need to return custom properties. return array( 'href' => DATAFACE_SITE_HREF.'?-action=reports', 'label' => $label, 'selected' => ($query['-action'] == 'reports') ); } // For other actions we need to make sure that they aren't selected // if the current action is reports because we want the 'reports' // tab to be selected only in that case. return array( 'selected' => ($query['-table'] == $key and $query['-action'] != 'reports') ); } } </code> ===See Also=== * [[isNavItemSelected]] - Overrides default behavior of whether a navigation item is currently selected. getNavItem, navigation menu en beforeHandleRequest 107 beforeHandleRequest Application Delegate Class Method Return to [[Application Delegate Class]] [[toc]] ===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 called after user authentication is taken care of, but before control has been passed to the specific action. This means that it is possible to do things such as change the current action or adjust query parameters depending on various factors. ===Example Uses=== * To require users to fill agree to license terms before they can visit particular parts of the application. * To implement custom logging functionality to record user actions * To change the default action for some or all tables. * To automatically create user accounts in some cases. * To change query parameters (e.g. default sorting etc...). ==Examples== ===Example 1: Changing the default action for a particular table=== <code> class conf_ApplicationDelegate { function beforeHandleRequest(){ $app = Dataface_Application::getInstance(); $query =& $app->getQuery(); // Make sure you assign by reference (i.e. =& ) // for this if you want to make changes to the query if ( $query['-table'] == 'dashboard' and $app->_conf['using_default_action'] ){ $query['-action'] = 'my_default_action'; } } } </code> In the above example, we make use of the Application configuration variable [[using_default_action]] to find out if the request is using the default action. This flag is set by Xataface if the user hasn't explicitly declared the action in the URL (i.e. -action has not explicitly been set). ==See Also== * [[Application Delegate Class]] * [http://dataface.weblite.ca/Dataface_Application Dataface_Application API Docs] * [[Xataface URL Conventions]] * '''[[Customizing Theme Based on IP Address]]''' - Article containing an example of using beforeHandleRequest hook. beforeHandleRequest, Application Delegate en getResetPasswordEmailInfo 122 getResetPasswordEmailInfo Application Delegate Class Method Return to [[Application Delegate Class]] [[toc]] ===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. ===Signature=== <code> function getResetPasswordEmailInfo(Dataface_Record $user, string $reset_url){} </code> ===Parameters=== * '''$user''' - The Dataface_Record of the user whose password has been changed. * '''$reset_url''' - The URL where the user should go to reset their password. When they visit this URL they will receive a message saying that their password has been changed and the new password has been emailed to them. That subsequent email can be customized using the [[getPasswordChangedEmailInfo]] method. ===Returns=== This method should return an associative array with 0 or more of the following keys: * '''subject''' - The subject line of the email. * '''message''' - The message content of the email. * '''headers''' - The Email headers (as a string). * '''parameters''' - Extra parameters for the mail function. ==See Also== * [[getPasswordChangedEmailInfo]] - A delegate class method to define the email that is sent to the user once their password has been reset to a temporary password. It informs the user of their new temporary password and should include instructions on how to change their password to their own choice. This step immediately follows the reset password step. forgot password, reset password en getPasswordChangedEmailInfo 121 getPasswordChangedEmailInfo Application Delegate Class Method Return to [[Application Delegate Class]] [[toc]] ===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 Xataface 1.3. Exists in 1.3 or higher. ===Signature=== <code> function getPasswordChangedEmailInfo(Dataface_Record $user, string $password){} </code> ===Parameters=== * '''$user''' - The Dataface_Record of the user whose password has been changed. * '''$password''' - The new temporary password that has been assigned to the user. ===Returns=== This method should return an associative array with 0 or more of the following keys: * '''subject''' - The subject line of the email. * '''message''' - The message content of the email. * '''headers''' - The Email headers (as a string). * '''parameters''' - Extra parameters for the mail function. ==See Also== * [[getResetPasswordEmailInfo]] - A delegate class method to define the email that is sent to the user when they request a password reset. This is the step that immediately precedes the Password Changed email step. forgot password, reset password en after_action_activate 181 after_action_activate Delegate Class Method Return to [[Application Delegate Class]] [[toc]] 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 registration process goes as follows: # User fills in registration form. # An email is sent to the user with a link to activate their account. # User clicks on activation link. # User is taken back to the application and activation occurs, which consists of creating a new record in the '''users''' table. # The ''after_action_activate'' trigger is called. ===Since=== This hook has been available since Xataface Version 1.2 ===Example=== <code> /** * A trigger to send the user a confirmation email after their account has been activated. * @params array $params Associative array of passed parameters. Contains a single key 'record' * with the Dataface_Record object of the users table with the user that was activated. */ function after_action_activate(array $params){ $user = $params['record']; mail($user->val('email'), 'Your account is activated', 'Your account has been activated... etc..'); } </code> ===See Also=== * [[Application Delegate Class]] * [[registration_form]] - More information user registration forms. * [[beforeRegister]] - Trigger called before the user registration form is saved. * [[afterRegister]] - Trigger called after registration form is saved. * [[validateRegistrationForm]] - Validates the input into the registration form. * [[sendRegistrationActivationEmail]] - Overrides the sending of the registration activation email. * [[getRegistrationActivationEmailInfo]] - Overrides the activation email info. Returns an associative array of the email details (e.g. subject, to, headers, etc... * [[getRegistrationActivationEmailSubject]] - Returns the subject of the activation email. * [[getRegistrationActivationEmailMessage]] - Returns the message body for the activation email. * [[getRegistrationActivationEmailParameters]] - Returns the parameters for the actication email. * [[getRegistrationActivationEmailHeaders]] - Returns the headers for the activation email. Registration, activation, register, activate, users en before_authenticate 102 before_authenticate hook 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 meant to be used to perform custom code that may affect the authentication settings. ===Since=== This hook has been available since Xataface Version 1.2.5. ===Example=== <code> /** * Implemented trigger to be called before authentication to set the authentication * type to basic. */ function before_authenticate(){ $auth = Dataface_AuthenticationTool::getInstance(); if ( @$_SESSION['-login-type'] == 'basic' ) $auth->setAuthType('basic'); } </code> In the above example we used a separate action to store the user's preferred login type in a session variable. This preference is then applied in the before_authenticate method to override the authentication type. ===Chain Authentication Support=== The most common use of this hook is likely to implement some sort of chain authentication, where authentication methods are attempted until one succeeds. ===See Also=== * [[Application Delegate Class]] * [[authentication]] - Overview of Xataface authentication * [[Writing Custom Authentication Plugins]] * [[Authenticating Against the PHPBB Users Table]] * [[LDAP or Active Directory]] - Using LDAP or Active Directory for authentication. * [http://xataface.com/documentation/tutorial/getting_started/permissions Permissions Section of the Getting Started tutorial] * [[_auth]] - Directives available in the [[_auth]] section of the [[conf.ini file]]. authentication en viewable_editable_fields 180 How to make a field editable for some users and only viewable for some other users 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. ==permissions.ini== <code> [Field Viewer] view=1 edit=0 new=0 [Field Editor extends Field Viewer] new=1 edit=1 </code> ==TableX.php (Delegate class of TableX)== <code> function fieldX__permissions(&$record) { $user=&Dataface_AuthenticationTool::getInstance()->getLoggedInUser(); if($user) { if($user->val('usernameField')=="UserX") $role='Field Viewer'; else if($user->val('usernameField')=="UserY") $role='Field Editor'; return Dataface_PermissionsTool::getRolePermissions($role); } return Dataface_PermissionsTool::NO_ACCESS(); } </code> en test_page_34 177 Hello World Hello world en calendar 100 Calendar Widget Back to [[widget:type]] [[toc]] ===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 different date and time formats, themes, starting days of the week, and more. [[image:http://media.weblite.ca/files/photos/calendar_widget.png?max_width=400]] ===Usage=== For DATE and DATETIME fields, the calendar widget is the default widget used, so you need not specify it explicitly in the fields.ini file. For other types of fields you may designate them to use the calendar widget in the [[fields.ini file]] as follows: <code> [my_field] widget:type=calendar </code> ===Configuration Options=== The calendar widget supports some configuration options that can be set in the [[fields.ini file]]. These options are as follows: {| class="listing listing2" |- ! Name ! Description ! Default ! Version |- | [[widget:lang]] | The language to use for the calendar. This is a 2-digit ISO language code. | en | 0.5.3 |- | [[widget:theme]] | The theme to use for the calendar. It only ships with one theme at present. | calendar-win2k-2 | 0.5.3 |- | [[widget:firstDay]] | The first day of the week (e.g. Monday=1) | 1 | 0.5.3 |- | [[widget:showsTime]] | Boolean value indicating whether the calendar should show the time as well. | 0 for DATE fields, 1 for DATETIME fields. | 0.5.3 |- | [[widget:ifFormat]] | The input format of the date. This takes a formatting string as supported by [http://ca2.php.net/strftime the strftime function]. | %Y-%m-%d %I:%M %P | 0.5.3 |- | [[widget:timeFormat]] | Whether to use 12 hour or 24 hour time format. | 12 | 0.5.3 |} ===Examples=== ====Setting the time to use 24 hour format==== In your [[fields.ini file]]: <code> [my_field] wiget:type=calendar widget:timeFormat = 24 </code> ===See Also=== * [[date]] Widget - A widget for editing date and time using select drop-down lists. * [[time]] Widget - A widget for selecting time from a set of possibilities in a single select list. calendar widget, fields.ini file, widget:type en beforeSave 109 beforeSave Trigger Back to [[Delegate class methods]] [[toc]] ===Synopsis=== The beforeSave trigger can be implemented in any table's [[delegate class|Delegate Class Methods]] to perform functionality that should be run *before* a record of that table is saved. This is a useful place to insert additional field values depending on the input of the save record form. This method is called both when records are inserted and when existing records are updated. Some other triggers include [[beforeInsert]], [[beforeUpdate]], [[afterSave]], [[afterInsert]], and [[afterUpdate]], which do what you might expect. ===Method Signature=== <code>function beforeSave( Dataface_Record $record);</code> ====Parameters==== # '''$record''' - The record that is about to be saved. This is a [http://dataface.weblite.ca/Dataface_Record Dataface_Record] object. ====Returns==== # [http://dataface.weblite.ca/Dataface_Error Dataface_Error] on failure (if you want to cancel the save). ===Examples=== Given a table named "people", suppose we wanted to automatically populate a field named "full_name" with the concatenation of the "first_name" and "last_name" fields. (Note you could also achieve a similar thing by making a calculated field for "full_name", but for this example, we assume that we actually want to store this in the database. We create a beforeSave() trigger that automatically updates the "full_name" field every time the record is saved. In the "people" table delegate class (i.e. tables/people/people.php) <code> class tables_people { function beforeSave($record){ $record->setValue('full_name', $record->val('first_name').' '.$record->val('last_name') ); } } </code> ==See Also== * [http://www.xataface.com/documentation/tutorial/getting_started/triggers Triggers section of the Xataface Getting Started Tutorial] triggers, beforeSave, en Introduction_to_the_Xataface_API 101 Introduction to the Xataface API Back to [http://xataface.com/wiki the wiki] [[toc]] ===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, delete, and save records), build forms, use templates, and more. This section of the wiki endeavors to highlight some of the more useful and commonly used aspects of the API. ===The dataface-public-api.php Facade=== Much of the functionality provided by the Xataface API is wrapped up easy-to-use functions which are made available in the dataface-public-api.php script, which is always present in a Xataface application (it is loaded at the beginning of your index.php file). ===Some Common Tasks=== ====Loading a Single Record from the Database==== <code> // Load record from 'people' table matching person_id=10 $record = df_get_record('people', array('person_id'=>10)); // Load record from people table with first_name 'John' and last_name 'Smith' $record2 = df_get_record('people', array('first_name'=>'=John', 'last_name'=>'=Smith')); // $record and $record2 are Dataface_Record objects. echo "Loaded Person: ".$record->val('person_id'). " named ".$record->val('first_name').' '.$record->val('last_name'); </code> In the above examples we load a [http://dataface.weblite.ca/Dataface_Record Dataface_Record] object and use the val() method to display particular field values. The 2nd arguments of df_get_record() is an array which serves as a query. See [[URL Conventions]] for more examples of the types of queries that you can provide here. ====Loading a set of records from the Database==== <code> // Load the first 30 canadians from the people table $people = df_get_records_array('people', array('nationality'=>'=canadian')); foreach ( $people as $person){ // $person is a Dataface_Record object echo "<br>Person ".$person->val('person_id')." is named ".$person->val('first_name'); } </code> '''Caveat: Note that when loading records using df_get_records_array() it only loads a preview of each record for memory's sake.''' A preview of the record is the same as a full record except that all fields are truncated to be less than 255 characters. If you have long text fields that you need to load, then these will be truncated. There are a few different solutions if you need to load the entire contents of a long field, including: * Use df_get_record instead. (This is only preferable if you are only loading a single record). * Use the [[struct]] [[fields.ini file]] directive on the field to designative the field contents as a 'stucture' that should never be truncated. * Use the extended form of ''df_get_records_array()'' with the 5th parameter (preview) set to false. E.g. <code> $people = df_get_records_array('people',array(), null, null, false); </code> ====Editing and Saving a Record==== <code> $person = df_get_record('people', array('person_id'=>10)); // Using setValue() to set a single field value. $person->setValue('first_name', 'Peggy'); // Using setValues() to set multiple field values at once $person->setValues(array('first_name'=>'Peggy', 'last_name'=>'Sue')); // Commit the changes to the database $person->save(); </code> xataface api, df_get_record, df_get_records_array, Dataface_Record, Editing, Saving, Loading, Searching en testpage2 2 testpage2 Another test page [[testpage]] en 0 __prefs__ 9 __prefs__ ==__prefs__ fields.ini Section== A global section of the [[fields.ini file]] that sets the preferences for the given table and its records. E.g. <code> [__prefs__] hide_posted_by=1 ; Hides the "Posted by" text in glance lists (e.g. related records in the view tab). hide_updated=1 ; Hides the "Updated" text in glance lists (e.g. the related records in the view tab). </code> ===Available Preferences=== Ultimately, all of the preferences available at a global level should be available here, however currently this is not the case and only selected preferences are available at the table level. {| class="listing listing2" ! Name ! Description ! Version |- | [[hide_posted_by]] | HIdes the ''posted_by'' text in glance lists. E.g. In the view tab of a record, the related records are shown in the left column. This will hide the ''posted_by'' text next to each related record. | 1.0b4 |- | [[hide_updated]] | Hides the ''updated'' text in glance lists. E.g. In the view tab of a record, the related records are shown in the left column. This will hide the ''updated'' text next to each related record. | 1.0b4 |- |} en 0 URL_Conventions 37 URL_Conventions ==Xataface URL Conventions== [[toc]] 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 parameters to can jump directly to any point in your application, or produce a specific result set. For example, the URL ''index.php?-table=people'' will take you to the ''people'' table (and since the default action for a Xataface application is ''list'', it will take you to the ''list'' view. You could be more explicit by specifying the action in the URL directly: ''index.php?-table=people&-action=list''. This would take you to the same screen. From this example, you see that you can specify such things as the table and action via GET parameters. Xataface accepts many more GET parameters also, as you'll see in the next section. ===Available GET Parameters=== {| class="listing listing2" |- ! Name ! Description ! Default ! Version |- | -action | Specifies the action to perform. E.g. ''browse'', ''list'', ''find'', ''edit'', ''new'', ... etc.. | list | all |- | -table | The name of the table to use as the context table. | The first table in the [_tables] section of your [[conf.ini file]] | all |- | -skip | Skip a certain number of results in the current found set to display. E.g. If there are 100 records in the table and you want to start browsing from the 30th record, you would set ''-skip=29''. Not to be confused with the ''-cursor'' parameter which is used to specify which record to view in the ''details'' tab. | 0 | all |- | -limit | The maximum number of records in the found set to display. | 30 | all |- | -cursor | The index of the record in the current found set that is treated as the "current" record. This is used in the ''details'' tab to identify which record to act on. E.g. which record to view or edit. | 0 | all |- | -sort | A comma-delimited list of columns to sort the result set on. | null | all |- | -relationship | If we are browsing related records, this specifies the name of the relationship. | null | all |- | -related:start | If we are browsing related records, this is the first record in the relationship to show. | 0 | all |- | -related:limit | If we are browsing related records, this is the number of records to show per page. | 30 | all |- | -search | A keyword search term to filter the found set on. Any row containing any field that matches the query will be returned. | null | all |- | --no-query=1 | A flag to indicate that xataface should not query the database by default. This flag is used in the new record form to prevent the form parameters from being interpreted as query parameters to search in the database. If you set this flag, it likely result in a message saying "No records found". Generally you would only use this in a custom action where you are not relying on Xataface's default found set. | 0 | 1.3 |} There are many other GET parameters that are used in various contexts but the above parameters are available throughout the entire application. ===Finding Records using the URL=== Notice that all of the GET parameters mentioned in the previous section begin with a hyphen (i.e. '-'). This is a convention Xataface uses to distinguish directives from search queries. All parameters that do not begin with '-' are treated as a query to filter the found set. For example, ''first_name=bob'' used as a GET parameter would cause the found set to be filtered so that only records where the ''first_name'' column contains the phrase "bob" are returned. Putting this all together, suppose we wanted to show the list tab for the ''people'' table, but only wanted to show the people with first names containing "bob": index.php?-action=list&-table=people&first_name=bob ====Exact, Range, and Pattern Matching==== By default, queries on text columns look for partial matches. I.e. if you search for "bob" it will match "bob", "bobby", "rubob", and any other text that contains "bob". If you are only interested in finding records that match ''exactly'' "bob", then you can prepend an "=" to the query. E.g. ''first_name==bob'', or the full URL: index.php?-action=list&-table=people&first_name==bob This should show the ''list'' tab for the ''people'' table with only records with first name exactly "bob". There are a number of modifiers that you can prepend to your query to modify how it is executed. They are as follows: =====Search Operators===== {| class="listing listing2" |- ! Prefix ! Usage Example ! Description |- | > | age=>10 | Match records greater than search parameter. |- | < | age=<10 | Match records less than search parameter. |- | >= | age=>=10 | Match records greater than or equal to the search parameter. |- | <= | age=<=10 | Match records less than or equal to the search parameter. |- | .. | age=10..20 | Match records in a given range. |- | = | first_name==bob | Match records that exactly match the search parameter (if there is no prefix then it will search for partial matches on text/varchar/char fields.). |- | ~ | first_name=~a% | Exact match, but you can include wildcards such as '%' and '?' in your search. |} =====Search Examples===== Given the following data set: {| class="listing listing2" |- ! first_name ! age |- | Bob | 10 |- | Cindy | 12 |- | Julie | 6 |- | Jake | 8 |- | Kabob | 16 |} Here are some example queries on this data set and their results: {| class="listing listing2" |- ! Query ! Matches |- | age=>10 | match records where ''age'' is greater than 10. This includes ''Cindy'' and ''Kabob''. |- | age=<10 | match records where ''age'' is less than 10. This includes ''Julie'' and ''Jake'' |- | age=>=10 | match records where ''age'' is greater or equal to 10. This includes ''Bob'', ''Cindy'', and ''Kabob''. |- | age=<=10 | match records where ''age'' is less than or equal to 10. This includes ''Bob'', ''Julie'', and ''Jake''. |- | age=8..10 | match records where ''age'' is between 8 and 10. This includes ''Bob'' and ''Jake''. |- | first_name=bob | Matches records where ''first_name'' contains "bob". This includes ''Bob'' and ''Kabob''. |- | first_name==bob | Matches records where ''first_name'' is exactly "bob". This includes ''Bob'' only. |- | first_name=~J% | Matches records that begin with "J". This includes ''Jake'' and ''Julie'' |} ====Matching on Related Records==== It is also possible to match records based on their related data (i.e. data that is not physically stored in the record itself, but in related records via a relationship). For example if we want to find authors who have written about a particular topic, we would normally have to first find all of the articles that contain a topic, and then cross-reference that result against the ''authors'' table. With Xataface we can perform this query directly from the ''authors'' table using something like the following query: index.php?-table=authors&articles/title=sports This assumes that the ''authors'' table has a relationship named ''articles'' that contains all of the articles that an author has written. So the above query returns precisely those authors who have written at least one article whose ''title'' field contains the phrase "sports". =====Anatomy of a Related Query===== %relationship%/%field%=%query% This matches all records in the current table such that at least one record in its ''<relationship>'' relationship matches the query: ''%field%=%query%''. ====Using the ''OR'' Operator==== Xataface allows you to search for more than one value at a time using the ''OR'' operator. E.g. first_name=bob+OR+steve Would match all records with ''first_name'' containing "bob" or "steve". first_name=bob+OR+=steve Would match all records with ''first_name'' containing "bob" or exactly matching "steve" age=<10+OR+>20 Would match all records with age less than 10 or greater than 20. ====Combining Multiple Queries in One Request==== Xataface allows you to filter on more than one field at a time. If you combine multiple queries in the same request it has the effect of strengthening the filter, matching only those rows that match ''both'' queries. E.g. age=>10&first_name=bob would match all records where ''age'' is greater than 10 '''AND''' that have ''first_name'' containing "bob". =====Examples of Combined Queries===== Given the same data set as the previous set of examples: {| class="listing listing2" |- ! first_name ! age |- | Bob | 10 |- | Cindy | 12 |- | Julie | 6 |- | Jake | 8 |- | Kabob | 16 |} first_name=bob&age=11 would return no matches because there are no records that contain both ''first_name'' "bob" and ''age'' 11. However first_name=bob&age=10 would return only ''Bob'' and first_name=bob&age=16 would return only ''Kabob''. ====Special Common Queries==== =====Search For Null or Blank Value===== Searching for a null value or a blank value is an exact match for "". Therefore you can simply search for "=". E.g. To find records with a null or blank first_name you would use the query ''first_name==''. Or the full query: index.php?-table=people&first_name== =====Search for Non-blank Value===== Searching for a non-blank value is the same as searching for a value greater than "". Therefore you can simply search for ">". E.g. if you wanted to find records with a first_name, you would use the query ''first_name=>''. Or the full query: index.php?-table=people&first_name=> ==Preserved vs Non-preserved Parameters== As mentioned above any parameters that are prefixed by a hyphen (i.e. "=") are treated as directives rather than search filters. Hence if you want to use your own GET parameters you should always prefix them with a "-" to ensure that Xataface does not attempt to apply it as a search filter. In order to keep a consistent context for users, all browsing within the same table preserves both search queries and directives. Hence if you go to the URL: index.php?-table=people&-action=list&first_name=bob It will show you the ''list'' tab of the ''people'' table with only those records with ''first_name'' "bob". Now if you click on the ''details'' tab it will preserve your query ''first_name''. The query will become something like: index.php?-table=people&-action=details&first_name=bob&...etc... more parameters (Although the parameters may appear in a different order). This allows you to navigate forward and back to previous and next records and stay within the same found set. It also ensures that if you click on the ''list'' tab to return to the list view, it will retain your place in the list. Note that navigating within the same table it will also preserve your directives. E.g. If you specify the ''-limit'' directive to show 100 records per page: index.php?-table=people&-action=list&-limit=100 And then you click on the ''details'' tab, it will retain your ''-limit'' parameter. Of course the ''-limit'' parameter is not actually used by the ''details'' action because it works on only one record at a time (it uses the ''-cursor'' parameter instead), when you click back on the ''list'' tab it will still show you 100 records per page. Because of this, we call the ''-limit'' parameter a preserved parameter. It is retained when navigating within the same table. '''Note:''' parameters are retained in the HTTP Query string, not in sessions or cookies. This ensures that there are no surprises when you enter a URL to your Xataface application. ===Unpreserved Parameters=== If you ''don't'' want Xataface to preserve one of your parameters, you should prefix two hyphens to the parameter name. I.e. "--". One example of an unpreserved parameters throughout Xataface applications is the ''--msg'' parameter. The value of this parameter will be displayed on the page as an info message to the user. Clearly you don't want this parameter preserved across requests, as you only want the user to see a message once. E.g. index.php?--msg=Record+Successfully+saved. Would didsplay the mesage "Record Successfully Saved" at the top of the page. If you click on any link in the application, it will not retain the ''--msg'' parameter so you will not see the message on subsequent requests. This parameter is useful if you want to give feedback to the user about an action that has been carried out. ===Summary=== {| class="listing listing2" |- ! Parameter Type ! Prefix ! Examples ! Description |- | Preserved | - | -limit, -skip, -cursor, -action, -table | Parameter value is preserved when user navigates away from the page (within the same table). |- | Unpreserved Parameters | -- | --msg | Parameter is ''NOT'' retrained with the user navigates away from the page. |} URL Conventions, GET Parameters, POST parameters, Request Parameters en 0 Troubleshooting 49 Troubleshooting ==Xataface Troubleshooting== This document is intended to help Xataface developers through some of the most common issues. [[toc]] ==All I get is a blank white screen!== The most common issue mentioned in the forums is that an application comes up with a blank white screen in the web browser. This can happen for a number of reasons but the most common reason is because PHP has encountered a fatal error and your PHP installation is not set up to display errors. The first step to troubleshooting this problem must be to find out what the error is. You can do that in one of the following ways: # Check your Apache error log if you know where it is. One common location on many linux installations is <code> /var/log/httpd/error_log </code> but your system may have it located elsewhere. If you cannot find your error log, continue to the next option. # Turn on the ''display_errors'' flag in your ''php.ini'' file. I.e., in your ''php.ini'' file, find where it says <code> display_errors Off </code> and change it to <code> display_errors On </code>. After this is done, restart your apache webserver. If you don't know where your ''php.ini'' file is located see the section later in this document on locating your ''php.ini'' file. If you don't have access to your php.ini file, move on to the next option. # In your application's ''.htaccess'' file, add the following directives to enable displaying errors:<code> php_flag display_errors on </code> . Note that this method will only work if your apache config file allows you to override these values at the directory level. If you still get a blank white screen after this, continue to the next option. # At the beginning of your application's index.php file, add the following:<code> <?php error_reporting(E_ALL); ini_set('display_errors', 'on'); </code> . Note that if the error occurs in the parsing or compiling of your PHP files you will still get a blank screen. But this will at least display runtime errors on the page. Once you can see the error messages that caused the blank white screen you are in a much better position to solve the problem. ==Locating your php.ini file== Locating your ''php.ini'' file is actually quite easy. The quickest way is to create a php script with the following contents: <code> <?php phpinfo(); </code> then navigate to this page in your web browser. This look at the line where it says the ''php.ini file''. It will list the path there. en 0 xataface_templates 23 xataface_templates ==Xataface Templates== [[toc]] Xataface uses the [http://smarty.php.net 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%/templates Where %XATAFACE_ROOT% is the Xataface directory (includes files such as dataface-public-api.php), and %SITE_ROOT% is the path to your application. You may also have subdirectories within these templates directories. ===Cascading Templates=== Xataface uses a simple cascading technique for deciding which template to use. If there are templates in the %SITE_ROOT%/templates and %XATAFACE_ROOT%/Dataface/templates directories with the same name, then Xataface will use the one in the %SITE_ROOT%/templates directory. In this way, you are able to override any of Xataface's core templates by adding one of the same name to your %SITE_ROOT%/templates directory. The most common template to override is the Dataface_Main_Template.html template which defines the look and feel for the entire application (e.g. header, footer, etc...). Hence, if you wanted to customize the look & feel of your application, you would likely start by copying %XATAFACE_ROOT%/Dataface/templates/Dataface_Main_Template.html into the %SITE_ROOT%/templates directory and make modifications to it as desired. ===Useful Smarty Tags introduced by Xataface=== In addition to the standard set of Smarty tags, Xataface templates provide some of its own. ==Xataface Templates== Xataface uses the [http://smarty.php.net 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%/templates Where %XATAFACE_ROOT% is the Xataface directory (includes files such as dataface-public-api.php), and %SITE_ROOT% is the path to your application. You may also have subdirectories within these templates directories. ===Cascading Templates=== Xataface uses a simple cascading technique for deciding which template to use. If there are templates in the %SITE_ROOT%/templates and %XATAFACE_ROOT%/Dataface/templates directories with the same name, then Xataface will use the one in the %SITE_ROOT%/templates directory. In this way, you are able to override any of Xataface's core templates by adding one of the same name to your %SITE_ROOT%/templates directory. The most common template to override is the Dataface_Main_Template.html template which defines the look and feel for the entire application (e.g. header, footer, etc...). Hence, if you wanted to customize the look & feel of your application, you would likely start by copying %XATAFACE_ROOT%/Dataface/templates/Dataface_Main_Template.html into the %SITE_ROOT%/templates directory and make modifications to it as desired. ===Useful Smarty Tags introduced by Xataface=== In addition to the standard set of Smarty tags, Xataface templates provide some of its own. {| class="listing listing2" |- ! Name ! Description ! Version |- | [[templates:tags:use_macro|use_macro]] | Include another template with the option to override certain sections. | 0.6 |- | define_slot | Marks a section that can be overridden by other templates that include this one via the use_macro tag. | 0.6 |- | fill_slot | Overrides content in a template that has been included via the use_macro tag. | 0.6 |- | block | Marks an insertion point where content can be inserted by delegate classes and modules. | 0.6 |- | load_record | Loads a [http://dataface.weblite.ca Dataface_Record] object from the database to be used in the template. | 0.6 |- | group | Groups an array of records together based on a field value. | 0.6 |- | img | Displays a thumbnail of an image. | 0.6 |- | actions | Loads an associative array of actions defined in the actions.ini file, based on certain criteria. | 0.6 |- | actions_menu | Displays a menu of actions based on certain criteria. | 0.6 |- | record_actions | A specialization of the actions_menu tag. This displays a menu of actions only in the record_actions category. | 0.6 |- | record_tabs | A specialization of the actions_menu tag. This displays a menu of actions only in the record_tabs category. | 0.6 |- | result_controller | Displays the paging controls for the current table's records. Use this for any listing of records. | 0.6 |- | result_list | Displays the result list (from the list tab) for the current request. | 0.6 |- | related_list | Displays the related records list for the current request. | 0.6 |- | bread_crumbs | Displays the bread crumbs for the current request. | 0.6 |- | search_form | Displays the find form for the current table. | 0.6 |- | language_selector | Displays a menu to select the user's preferred language. | 0.6 |- | next_link | Displays a link to the next XXX records. | 0.6 |- | prev_link | Displays a link to the previous XXX records. | 0.6 |- | jump_menu | Displays the select list of the records found in this found-set so that the user can jump directly to any record. | 0.6 |- | limit_field | Displays a text field for the user to select the number of records to display per page. | 0.6 |- | result_index | Displays the index of pages (1 to XXX) for this query. | 0.6 |- | summary_list | Displays a list of records in the current found set using a summary format rather than the regular table format. | 0.6 |- | sort_controller | Displays a control to sort the results on any column. | 0.6 |- | glance_list | Displays a simple, brief list of records matching certain criteria. | 0.6 |- | record_view | Loads structured data for a record as required for the view tab. | 0.6 |- | feed | Generates a link to an RSS feed based on certain criteria. | 0.6 |- | translate | Display a section of text in the user's selected language. (i18n). | 0.6 |- | if_allowed | The contents of this block are shown only if the user has certain permissions. | 0.6 |- | editable | Make a section of the page editable using AJAX. | 0.6 |- | abs | Convert a URL into an absolute URL. | 0.6 |} ===Useful Template Variables=== Xataface makes certain variables available to every template: {| class="listing listing2" |- ! Name ! Description ! Version |- | $ENV.REQUEST | Reference to the $_REQUEST array (HTTP Request parameters, both GET and POST) | 0.6 |- | $ENV.SESSION | Reference to the $_SESSION array (the session variables) | 0.6 |- | $ENV.DATAFACE_PATH | The file system path to the Xataface directory (i.e. the directory containing all of the Xataface files such as dataface-public-api.php). | 0.6 |- | $ENV.DATAFACE_URL | The URL to the Xataface directory. | 0.6 |- | $ENV.DATAFACE_SITE_PATH | The file system path to your application directory. (i.e. the directory containing your conf.ini and index.php files). | 0.6 |- | $ENV.DATAFACE_SITE_URL | The URL to your application directory. | 0.6 |- | $ENV.DATAFACE_SITE_HREF | The URL to your application's script. This differs from the $ENV.DATAFACE_SITE_URL variable in that this also includes the script name. | 0.6 |- | $ENV.SCRIPT_NAME | Same as $ENV.DATAFACE_SITE_HREF | 0.6 |- | $ENV.APPLICATION | A reference to the application's conf array (i.e. the parsed contents of the conf.ini file). | 0.6 |- | $ENV.APPLICATION_OBJECT | A reference to the Dataface_Application object for the application. | 0.6 |- | $ENV.SERVER | A reference to the $_SERVER array. | 0.6 |- | $ENV.QUERY | A reference to the current query (i.e. Dataface_Application::getInstance()->getQuery()) | 0.6 |- | $ENV.action | The name of the current action as specified by the -action REQUEST parameter. | 0.6 |- | $ENV.table | The name of the current table as specified by the -table REQUEST parameter. | 0.6 |- | $ENV.table_object | A reference to the current table. | 0.6 |- | $ENV.relationship | The name of the current relationship as specified by the -relationship REQUEST parameter. | 0.6 |- | $ENV.limit | The value of the -limit REQUEST parameter. This is the number of records to show per page. | 0.6 |- | $ENV.start | The value of the -start REQUEST parmeter. This is the starting point in the result set which is currently being displayed. | 0.6 |- | $ENV.resultSet | A reference to the [http://dataface.weblite.ca/Dataface_QueryTool Dataface_QueryTool] object for this result set. | 0.6 |- | $ENV.record | A reference to the [http://dataface.weblite.ca/Dataface_Record Dataface_Record] object that is matched by the current query. | 0.6 |- | $ENV.mode | The name of the current mode. e.g. find, list, browse | 0.6 |- | $ENV.language | The 2-digit ISO language code that is currently selected as the user's preferred language. | 0.6 |- | $ENV.prefs | A reference to the preferences array ($conf['_prefs']) | 0.6 |- | $ENV.search | The value of the current full-text search (i.e. the search that was entered into the upper right search field. | 0.6 |} ==Smarty Plugins== One of the most powerful features of [http://www.smarty.net Smarty] is its pluggable architecture. You can easily add your own custom plugins to a registered "plugins" directory to add functions, modifiers, blocks, and other features to your templates. Prior to Xataface 2.0, you Smarty plugins could only be placed in the ''lib/Smarty/plugins'' directory of the Xataface distribution folder. This is not very conducive to Xataface updates, though. In general it is best practice to not change anything inside the xataface directory. Most other configuration and extensions can be handled by making changes to your application's directory which override corresponding functionality in Xataface. As of Xataface 2.0, you can create a directory named ''plugins'' to your application directory, Smarty knows to look in this directory for plugins. For versions of Xataface prior to 2.0, you can make a small modification to the SkinTool to also add support as desribed in [http://xataface.com/forum/viewtopic.php?f=4&t=6722 this post]. ===Example Plugin=== The following is an example Smarty plugin adapted from [http://www.smarty.net/docs/en/plugins.functions.tpl this page] but modified slightly to work in Xataface. It is a simple "eightball" plugin that adds a tag {eightball} to Xataface that you can use in any of your templates. Whenever this tag is rendered it outputs one of a set of predefined strings randomly. # Add a ''plugins'' directory to your application directory. i.e. ''path/to/app/plugins'' # Add a file inside this ''plugins'' directory called ''<nowiki>function.eightball.php</nowiki>'' with the following content:<code> <?php /* * Smarty plugin * ------------------------------------------------------------- * File: function.eightball.php * Type: function * Name: eightball * Purpose: outputs a random magic answer * ------------------------------------------------------------- */ function smarty_function_eightball($params, Dataface_SkinTool $template) { $answers = array('Yes', 'No', 'No way', 'Outlook not so good', 'Ask again soon', 'Maybe in your reality'); $result = array_rand($answers); return $answers[$result]; } </code> # If you compare this function to the original example in [http://www.smarty.net/docs/en/plugins.functions.tpl the smarty tutorial] you'll notice that the 2nd parameter has been changed to type ''Dataface_SkinTool'' from ''Smarty_Internal_Template''. If you don't make this change, you will get a fatal error when you try to use the tag. This function defines an ''{eightball}'' tag that can be added to any Smarty template in Xataface. # Next we'll create a template that uses this tag. If your application doesn't have a ''templates'' directory, create one now (i.e. path/to/app/templates). # Add a file inside your templates directory called ''testing.html'' with the following content:<code> The eight ball says {eightball} </code> # Now we need to display this template somewhere in our interface. In this case, we'll choose the ''before_record_content'' block. (This will render the template before the main section of the view tab). Add the following method to your [[Application_Delegate_Class]]:<code> function block__before_record_content(){ df_display(array(), 'testing.html'); } </code> # Now if you load your application in a web browser and navigate to the details view for a record, you should see something like the following: <nowiki><img src="http://media.weblite.ca/files/photos/Screen_Shot_2012-04-16_at_12.33.01_PM.png?max_width=640"/></nowiki> ===See also:=== * [http://www.xataface.com/documentation/tutorial/getting_started/changing-look-and-feel Changing the Look & Feel of Xataface] (From the Getting Started Tutorial) * [http://www.xataface.com/documentation/tutorial/customizing-the-dataface-look-and-feel Cusomizing the Xataface Look & Feel] Tutorial templates, plugins, smarty en 0 ShoppingCart 31 ShoppingCart ==Xataface Shopping Cart Module== [[toc]] Status: Under development Current Version: 0.2 ===Synopsis=== Add a shopping cart to your xataface application. You can treat any record as a product that can be sold. Includes Paypal connectivity, shipping calculation, and more. ===Requirements=== * Xataface 1.0 or higher * PHP 5 or higher * MySQL 4.1 or higher ===Installation Instructions=== # Download the ShoppingCart module, extract it, and place the ShoppingCart directory in your Xataface modules directory. (i.e. /path/to/xataface/modules/ShoppingCart). # Add the following line to the [_modules] section of your [[conf.ini file]]:<code> modules_ShoppingCart=modules/ShoppingCart/ShoppingCart.php </code> # Add the following to the beginning of your [[index.php file]]:<code> function __autoload($class){ if ( $class == 'ShoppingCart' ) require_once 'modules/ShoppingCart/lib/ShoppingCart/ShoppingCart.class.php'; } </code> # In the [[fields.ini file]] for any table whose records you wish to represent items for sale, add the following:<code> [__implements__] InventoryItem=1 </code> # Specify which fields should be used for the item description, price, width, height, length, and weight in the [[fields.ini file]] for each table whose records you wish to represent items for sale by adding the following directives to the appropriate fields:<code> ShoppingCart.description=1 ShoppingCart.unitPrice=1 ShoppingCart.weight=1 ShoppingCart.width=1 ShoppingCart.height=1 ShoppingCart.length=1 </code> E.g. if your table has a field named ""price"" that you want to represent the unit price, you would have something like:<code> [price] ShoppingCart.unitPrice=1 </code> The shopping cart module will make its best guess on which fields to use for these values if they are not explicitly specified. # Specify the paypal account where money should be deposited by adding the following to your application's [[actions.ini file]]:<code> [view_cart] paypal.account="youremail@example.com" </code> ===Usage Instructions=== Once the Shopping Cart module is installed you can: # Add items to your shopping cart # View your cart contents # Checkout and pay with paypal ====Adding Items to the Cart==== In the View tab of any salable record, you'll notice a little block on the left side of the page with the heading "Add Item to Cart". This includes a field to specify the quantity and a button to add the item to the shopping cart. ====Viewing Cart Contents==== The Shopping Cart module automatically introduces an action to view the cart contents. This action is named "view_cart". Hence you can always view the cart contents by entering the URL: index.php?-action=view_cart . ====Checking Out==== # View the cart contents. # Click "Check out" # This will take you to a paypal page to pay for your items. ==Actions== This module adds the following actions to your application. {| class="listing listing2" |- ! Name ! Content-type ! Description ! Version |- | checkout | text/html | Sends user to paypal to pay for the contents of their cart. | 0.1 |- | calculate_shipping | text/html | Calculates the shipping charges for the cart. | 0.1 |- | add_to_cart | text/html | Adds an item to the cart. | 0.1 |- | clear_cart | text/html | Empties the shopping cart. | 0.1 |- | get_shipping_provinces | text/json | Returns JSON array of provinces for a given country. | 0.1 |- | invoices | text/html | Displays the current user's invoices. | 0.1 |- | payment_complete | text/html | Page that is displayed after a successful payment on paypal. | 0.1 |- | paypal_ipn | none | Handles paypal events such as successful payments. | 0.1 |- | refresh_shipping_methods | text/html | Refreshes the shipping methods available to the system. | 0.1 |- | set_shipping_method | text/html | Sets the selected shipping method to a particular method. | 0.1 |- | view_cart | text/html | View the cart contents. | 0.1 |} ==Blocks and Slots== This module adds the following blocks and slots to your applications. {| class="listing listing2" |- ! Name ! Description ! Version |- | shipping_method | A block with a form to select the shipping method. | 0.1 |- | add_to_cart | A block with a form to add a record/item to the shopping cart. | 0.1 |} ==Application Delegate Class Hooks== You can modify the shopping cart behavior by defining the following methods to the application delegate class. {| class="listing listing2" |- ! Name ! Description ! Version |- | isShippingMandatory | Returns a boolean value indicating whether the user must select a shipping method. | 0.1 |- | getDefaultShippingMethod | Returns a string with the name of the default shipping method to be used. | 0.1 |} ==Table Delegate Class Hooks== You can modify the behavior of the shopping cart by defining the following methods to the delegate class of any table that implements the InventoryItem ontology (i.e. any table that is to be used to store products that can be added to the cart). {| class="listing listing2" |- ! Name ! Description ! Version |- | field__taxes | A calculated field that returns an associative array of all applicable taxes for a product. | 0.1 |} ==Internal Storage== This module creates the following tables to store its data: ===dataface__invoices=== The dataface__invoices table stores the actual invoices for purchases made. An invoice is automatically created as soon as the user "checks out". {| class="listing listing2" |- ! Column Name ! Data Type ! Description ! Version |- | InvoiceID | int(11) | Auto incrementing primary key for the invoice. | 0.1 |- | dateCreated | datetime | The date that the invoice was created. | 0.1 |- | dateModified | datetime | The date that the invoice was last modified | 0.1 |- | status | enum | The status of the invoice (either PENDING, PAID, or APPROVED). | 0.1 |- | amount | decimal(10,2) | The total amount on the invoice. | 0.1 |- | paymentMethod | varchar(32) | The name of the payment method used. | 0.1 |- | referenceID | varchar(64) | ?? | 0.1 |- | username | varchar(32) | The username of the user who owns this invoice. | 0.1 |- | firstName | varchar(32) | The first name of the payer. | 0.1 |- | lastName | varchar(32) | The last name of the payer. | 0.1 |- | address_name | varchar(100) | The name on the shipping address. | 0.1 |- | address1 | varchar(100) | The shipping address line 1. | 0.1 |- | address2 | varchar(100) | The shipping address line 2. | 0.1 |- | city | varchar(40) | The shipping address city. | 0.1 |- | province | varchar(2) | The shipping province or state. | 0.1 |- | country | varchar(2) | The shipping country. | 0.1 |- | postalCode | varchar(32) | The shipping postal code. | 0.1 |- | shipping_method | varchar(50) | The name of the shipping method to use. | 0.1 |- | phone | varchar(32) | The phone number of the payer. | 0.1 |- | email | varchar(127) | The email address of the buyer. | 0.1 |- | data | text | Serialize shopping cart data. | 0.1 |} ===dataface__shipping_methods=== Stores the available shipping methods. {| class="listing listing2" |- ! Column Name ! Data Type ! Description ! Version |- | shipping_method_id | int(11) | Auto increment ID for a shipping method. | 0.1 |- | shipping_method_name | varchar(50) | The name of the shipping method. | 0.1 |- | shipping_method_label | varchar(100) | The label for the shipping method (displayed to the user). | 0.1 |- | shipping_method_enabled | tinyint(1) | Whether or not this shipping method is currently enabled. | 0.1 |- | shipping_method_module | varchar(32) | The name of the handler that this shipping method belongs to. | 0.1 |} ==Payment Handlers== Information about payment handlers to be added here. ==Shipping Handlers== The Shopping Cart module is itself modular, allowing you to develop custom shipping handlers for different types of shipping. A shipping handler is responsible for calculating shipping costs to a destination address. Currently only a UPS shipping handler has been created, but it is not difficult to create other handlers. ===Shipping Handler Public Interface=== {| class="listing listing2" |- ! Method ! Description ! Version |- | calculateShipping | Calculates the shipping cost for the current shopping cart, and adds the shipping cost to the cart as a line item. | 0.1 |- | getInfo | Returns an array of shipping methods that can be handled by this handler. | 0.1 |} en 0 Using_RecordGrid 115 Using RecordGrid ==Xataface RecordGrid Class and Template== Also see [http://lamp.weblite.ca/dataface-0.6/docs/index.php?-table=Classes&-action=browse&ClassID=30| RecordGrid in the API Doc]. [[toc collapse=0]] ===Introduction=== As we learned in '''[http://xataface.com/documentation/tutorial/getting_started/dataface_actions Actions I: The Basics]''', we can retrieve custom data from the DB in action via queries. This site deals with showing data in tabular form, like it could be received from even such a query. It is done by using Dataface_RecordGrid. ===First Example=== <code> class actions_testTableAction { // Will be called from Xataface, if this action is called function handle(&$params){ $this->app =& Dataface_Application::getInstance(); // reference to Dataface_Application object // Custom query $result = mysql_query("select * from testTable", $this->app->db()); $body = "<br /><br />"; if(!$result) { // Error handling $body .= "MySQL Error ..."; }else { while($row = mysql_fetch_assoc($result)) // Fetch all rows { // Maybe do something with the single rows $data[] = $row; // Add singe row to the data } mysql_free_result($result); // Frees the result after finnished using it $grid = new Dataface_RecordGrid($data); // Create new RecordGrid with the data $body .= $grid->toHTML(); // Get the HTML of the RecordGrid } // Shows the content (RecordGrid or error message) in the Main Template df_display(array('body' => $body), 'Dataface_Main_Template.html'); } } </code> You get your data from the query, fetch it into an associative array, create with it an RecordGrid and use the toHTML function. This is sure better than manually create the html tags around the data. =====Screenshot: Blank RecordGrid===== <nowiki> <img src="http://i89.photobucket.com/albums/k234/horchr/xataface/RecordGrid_blank.png?max_width=610"/> </nowiki> =====Screenshot: ResultList===== <nowiki> <img src="http://i89.photobucket.com/albums/k234/horchr/xataface/RecordList.png?max_width=713"/> </nowiki> ===Colored Example=== As you see above, the resultlist has colored rows, our First Example not. But you can easily change this, when you override the Dataface_RecordGrid.html template: <code> <table id="{$id}" class="listing {$class}"> <thead> <tr> {foreach from=$labels item=label} <th>{$label}</th> {/foreach} </tr> </thead> <tbody> {section name=row loop=$data} <tr class="listing {cycle values="odd,even"}"> {foreach from=$columns item=col} <td>{$data[row][$col]}</td> {/foreach} </tr> {/section} </tbody> </table> </code> The magic happens in <tr class="listing {cycle values="odd,even"}"> The {cycle values="odd,even"} value cycles these two values and creates so the alternating row classes, like they are in the RecordList. By the way, {cycle ...} is a Smarty Function, see [http://www.smarty.net/docsv2/en/language.custom.functions.tpl| Smarty Doc]. (Find fruther information to template overriding in the tutorial and its links: [http://xataface.com/documentation/tutorial/getting_started/changing-look-and-feel| Changing the Look and Feel]) =====Screenshot: colored RecordGrid===== <nowiki> <img src="http://i89.photobucket.com/albums/k234/horchr/xataface/RecordGrid_colored.png?max_width=610"/> </nowiki> ===Example completly imitating ResultList=== The Colored Example doesn't look like the ResulList? Its rows aren't as high as theres? That's a styling matter or rather in this case a cause of the checkboxes. Here an example with checkboxes and added (empty) links, so it looks completly like the ResultList: Change the part in action.php <code> while($row = mysql_fetch_assoc($result)) // Fetch all rows { // Maybe do something with the single rows $row['<input type="checkbox">'] = '<input type="checkbox">'; $data[] = $row; // Add singe row to the data } mysql_free_result($result); // Frees the result after finnished using it $grid = new Dataface_RecordGrid($data, // Create new RecordGrid with the data array('<input type="checkbox">', 'testID', 'name', 'description', 'number'), //Order and selection of the colums null); // No other labels defined -> it uses keys of the associative array $body .= $grid->toHTML(); // Get the HTML of the RecordGrid </code> Dataface_RecordGrid.html template <code> <table id="{$id}" class="listing {$class}"> <thead> <tr> {foreach from=$labels item=label} <th><a class="unmarked_link">{$label}</a></th> {/foreach} </tr> </thead> <tbody> {section name=row loop=$data} <tr class="listing {cycle values="odd,even"}"> {foreach from=$columns item=col} <td><a class="unmarked_link">{$data[row][$col]}</a></td> {/foreach} </tr> {/section} </tbody> </table> </code> =====Screenshot: RecordGrid completly imitating ResultList===== <nowiki> <img src="http://i89.photobucket.com/albums/k234/horchr/xataface/RecordGrid_colored_checkboxes_links.png?max_width=610"/> </nowiki> =====Screenshot: ResultList===== <nowiki> <img src="http://i89.photobucket.com/albums/k234/horchr/xataface/RecordList.png?max_width=713"/> </nowiki> ===Try it out=== Use the following code with static test data and any template in this article (or even without overriding it) to try it out. <code> class actions_testTableAction { // Will be called from Xataface, if this action is called function handle(&$params){ $this->app =& Dataface_Application::getInstance(); // reference to Dataface_Application object $result_dummy = array( array('testID' => '1', 'name' => 'testname', 'description' => 'a short description', 'number' => '258'), array('testID' => '2', 'name' => 'another name', 'description' => 'a bit longer description to this data set', 'number' => '946'), array('testID' => '3', 'name' => 'dummy name', 'description' => 'yea, a dummy data set!', 'number' => '1342'), array('testID' => '4', 'name' => 'not empty', 'description' => 'this data set isn\'t empty ...', 'number' => '282'), array('testID' => '5', 'name' => 'your entry', 'description' => 'this entry is only for you', 'number' => '79'), array('testID' => '6', 'name' => 'no idea', 'description' => 'running out of ideas ...', 'number' => '203'), array('testID' => '7', 'name' => 'the last one', 'description' => 'the end', 'number' => '26841') ); $body = "<br /><br />"; foreach($result_dummy as $row) // Fetch all rows { // Maybe do something with the singe rows $row['<input type="checkbox">'] = '<input type="checkbox">'; $data[] = $row; // Add singe row to the data } $grid = new Dataface_RecordGrid($data, // Create new RecordGrid with the data array('<input type="checkbox">', 'testID', 'name', 'description', 'number'), //Order and selection of the colums null); // No other labels defined -> it uses keys of the associative array $body .= $grid->toHTML(); // Get the HTML of the RecordGrid // Shows the content (RecordGrid or error message) in the Main Template df_display(array('body' => $body), 'Dataface_Main_Template.html'); } } </code> RecordGrid, Dataface_RecordGrid, data in tabular form en preferences 10 preferences ==Xataface Preferences== [[toc]] Xataface preferences can be defined in 3 ways: # In the ''[_prefs]'' section of rhe [[conf.ini file]] for global static preferences. # Implementing the [[getPreferences]] method in the [[Application Delegate Class]] # In the [[__prefs__]] section of the fields.ini file for a table for static preferences on that table. (Limited to only certain preferences). ===Example [_prefs] section=== In the conf.ini <code> [_prefs] hide_updated=1 hide_posted_by=1 </code> ===Example [[getPreferences]] method=== In the [[Application Delegate Class]]: <code> function getPreferences(){ return array('hide_update'=>1, 'hide_posted_by'=>1); } </code> ===Available Preferences=== {| class="listing listing2" ! Name ! Description ! Default ! Version |- | show_result_stats | Show the result statistics (e.g. found x of y records in table z) | 1 | 0.6 |- | show_jump_menu | Show he drop-down menu that allows you to "jump" to any record in the found set. | 1 | 0.6 |- | show_result_controller | Show Next, previous, page number .. links... | 1 | 0.6 |- | show_table_tabs | Show Details, List, Find, etc... tabs. | 1 | 0.6 |- | show_actions_menu | Show New record, Show all, delete, etc.. | 1 | 0.6 |- | show_logo | Show logo at top of app | 1 | 0.6 |- | show_tables_menu | Show the tabs to select a table. | 1 | 0.6 |- | show_search | Show search field in upper right. | 1 | 0.6 |- | show_record_actions | Show actions related to particular record | 1 | 0.6 |- | show_bread_crumbs | Show bread crumbs at top of page to show where you are. | 1 | 0.6 |- | show_record_tabs | View, Edit, Translate, History, etc... | 1 | 0.6 |- | show_record_tree | Show tree to navigate the relationships of this record. | 1 | 0.6 |- | list_view_scroll_horizontal | Whether to scroll list horizontal if it exceeds page width | 1 | 0.6 |- | list_view_scroll_vertical | Whether to scroll list vertical if it exceeds page height. | 1 | 0.6 |- | hide_posted_by | Whether to hide the ''posted by'' text in glance lists (e.g. in the view tab, the related records are shown in the left column. This hides the ''posted by'' text next to each related record. | 0 | 1.0b4 |- | hide_updated | Whether to hide the ''updated'' text in the glance lists (e.g. in the view tab, the related records are shown in the left column. This hides the ''updated'' text next to each related record. | 0 | 1.0b4 |- | SummaryList_logo_width | The width of the logo to be used as the preview image in summary lists. | null | 0.7 |- | SummaryList_hideSort | Hides the sort control for a summary list (the box that allows users to sort by column). | 0 | 0.7 |- | hide_user_status | Hides the user's status (e.g. "You are logged in as ..." | 0 | 0.7 |- | hide_personal_tools | Hides the personal tool links in upper right. This includes likes such as "Control Panel" and "My Profile" | 0 | 0.7 |- | hide_resultlist_controller | Hides the controller for a result list (E.g. next/back/results per page etc...). | 0 | 0.7 |- | hide_related_sections | Hides the sections of the view tab that show the related records. These are the sortable section boxes. Not the related tabs. | 0 | 1.3 |- | hide_record_search | Hides the record search form that appears in the view tab. Not to be confused with the find tab. | 0 | 1.3 |- | show_resultlist_controller_only_when_needed | Sets the resultlist controller (e.g. back/next/results per page/etc...) to only show up if paging is required (i.e. if there are more records than can be shown on one page (according to the '-limit' parameter). | 0 | 1.0 |- | hide_record_view_logo | Hides the logo for a record that appears in the upper left of the view tab for each record. | 0 | 0.7 |- | horizontal_tables_menu | Whether to force the tables menu to appear as tabs along the top of the page (alternative is as a menu on the left). If there are 10 or fewer allowed tables, then the default is 1, otherwise the default is set to 0. | 1 | 0.6 |- | hide_result_filters | In list view, setting this value to 1 will cause the column filters to be hidden (the select lists to filter the results). | 0 | 0.7 |- | disable_select_rows | A value of 1 causes the checkboxes in each row of the list view to be hidden. | 0 | 0.7 |- | result_list_use_geturl | Use the getURL() method to link to records in the list view rather than the default (which uses the -cursor parameter). | 0 | 0.7 |- | disable_ajax_record_details | Whether to disable the ajax record details (the '+' sign beside each record in list view that expands to show the record details. | 1 | 0.7 |- | use_old_resultlist_controller | As of Xataface 1.1, a new style result list controller is used that resembles facebook. It is more slimmed down and is easier to manage. If you prefer the old controller, set this preference to 1. | 0 | 1.1 |} ===Inverse Preferences=== The following preferences perform the inverse of some of the options above. When these options are set to 1, their respective option is set to 0. {| class="listing listing2" ! Name ! Inverse |- | hide_nav_menu | show_tables_menu |- | hide_view_tabs | show_table_tabs |- | hide_result_controller | show_result_controller |- | hide_table_result_stats | show_result_stats |- | hide_search | show_search |} preferences, prefs, getPreferences en 0 examples 34 examples ==Xataface Examples== [[toc]] This section includes concrete examples of how Xataface has been used in the past. ===Demo Applications=== {| class="listing listing2" |- ! Screenshot ! Title/Description ! Developed by |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://demo.weblite.ca/apps/librariandb/]] | '''Librarian DB''' A searchable database of library books. Useful for small libraries (e.g. Church Libraries). Log in with: username: admin password: password [http://demo.weblite.ca/apps/librariandb/ Try the app] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://demo.weblite.ca/apps/webauction/]] | '''Web Auction''' A simple web-based auction application for organizations to hold auctions. Login with: username: admin password: password [http://demo.weblite.ca/apps/webauction/ Try the app] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |} ===Websites Powered by Xataface=== {| class="listing listing2" |- ! Screenshot ! Title/Description ! Developed by |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://fueleconomydb.com]] | '''Fuel Economy Database''' - A searchable database of gas mileage and fuel economy statistics for automobiles from 1986 to present. [http://fueleconomydb.com Visit the site] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://physics.sfu.ca]] | '''Department of Physics, Simon Fraser University''' This website is completely powered by Xataface. It is backed by a MySQL database that stores faculty members, research groups, news, events, and more. Faculty members are able to update their personal profiles and research profiles through a Xataface administration console. [http://physics.sfu.ca Visit the site] | [http://fas.sfu.ca/ SFU Faculty of Applied Sciences] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://science.ca]] | '''Science.ca''' The source for science in Canada. Includes profiles for prominent scientists as well as other useful science-related information. Xataface is used to power the bilingual (English/French) capabilities of this site. It includes web-based administrative console for the administrator to manage all content, and for translators to translate the content. [http://science.ca Visit the site] | Science.ca web team |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://translation.weblite.ca]] | '''Simple Website Translation Engine''' A service that allows website owners to easily convert their website into multiple languages. Support human and machine translation. This service is powered by Xataface, and provides an administrative console for users to manage their website translations. [http://translation.weblite.ca Visit the Site] [http://swete.weblite.ca More about this service] | [http://translation.weblite.ca Web Lite Translation Corp.] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://www.credituniondb.com]] | '''Credit Union Database''' A database of credit unions in the United States. This site is powered by Xataface. [http://www.credituniondb.com Visit the site] | Vlad |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://ierg.net/lessonplans/unit_plans.php]] | '''IERG Lesson Plans Database''' A searchable database of lesson plans created by the Imaginative Education Research Group. This database is managed by Xataface. It provides researchers with a web-based control panel to manage their lesson plans. [http://ierg.net/lessonplans/unit_plans.php Visit the site] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://ierg.net/people/]] | '''IERG People Database''' A simple database to manage the contributors and associates of the Imaginative Education Research Group. Administrators have a web-based control panel to manage the people profiles in this database. [http://ierg.net/people/ Visit the site] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://sustain-gradnetwork.envr.sfu.ca/]] | '''Sustainability Research Database''' A database at Simon Fraser University for grad students to post and share research profiles. [http://sustain-gradnetwork.envr.sfu.ca/ Visit the site] | [http://fas.sfu.ca Faculty of Applied Sciences Web Team] |- | [[Image:http://images.websnapr.com/?size=150&key=40f0knTakb1b&url=http://apps.weblite.ca/]] | '''Web Lite Applications Catalog''' A catalog of applications available through Web Lite Solutions. Allows users to set up their own online applications on Web Lite's servers. This site is completely powered by Xataface. [http://apps.weblite.ca/ Visit the site] | [http://solutions.weblite.ca Web Lite Solutions Corp.] |} examples, samples en 0