 |
Xataface 2.0
Xataface Application Framework
|
|
Xataface 2.0
Xataface Application Framework
|
Public Member Functions | |
Initialization | |
| init (Dataface_Table $table) | |
| Called after a table is loaded for the first time each request. | |
Permissions | |
| getPermissions (Dataface_Record $record) | |
| Returns associative array of permissions that should be granted to the current user on this record. | |
| getRoles (Dataface_Record $record) | |
| Returns one or more roles that are to be granted to the current user for the specified record. | |
| __field__permissions (Dataface_Record $record) | |
| Returns default permissions for all fields of the given record to be granted to the current user. | |
| __field__roles (Dataface_Record $record) | |
| Returns the roles for all fields of the given record to be granted to the current user. | |
| fieldname__permissions (Dataface_Record $record) | |
| Returns the permissions for a particular field of the given record. | |
| fieldname__roles (Dataface_Record $record) | |
| Returns the roles for a particular field of the given record. | |
| rel_relationshipname__permissions (Dataface_Record $record) | |
| Returns the permissions for a particular relationship of the given record. | |
| rel_relationshipname__roles (Dataface_Record $record) | |
| Returns the roles for a particular relationship of the given record. | |
| no_access_link (Dataface_Record $record, $params=array()) | |
| Returns the link that should be returned by Dataface_Record::getURL() if the user isn't granted the 'link' permission on the given record. | |
| no_access_text (Dataface_Record $record, $params=array()) | |
| Returns the text that should be returned by Dataface_Record::display() if the user doesn't have 'view' permission for the record. | |
Record Metadata | |
| getTitle (Dataface_Record $record) | |
| Returns the record's title. | |
| getURL (Dataface_Record $record, $params=array()) | |
| Returns the URL of the given record. | |
| getLastModified (Dataface_Record $record) | |
| Returns the Unix timestamp representing the last modification time of the given record. | |
| getDescription (Dataface_Record $record) | |
| Returns a brief description of this record for use in lists, RSS feeds, and more. | |
| getCreator (Dataface_Record $record) | |
| Returns the name of the user who created this record (i.e. the record author). | |
| getPublicLink (Dataface_Record $record) | |
| Returns the publicly accessible URL for a given record. | |
| getBreadCrumbs (Dataface_Record $record) | |
| Returns the breadcrumbs to a given record. | |
| getChildren (Dataface_Record $record) | |
| Returns the records that are considered to be children of the given record. | |
Field Filters | |
| fieldname__display (Dataface_Record $record) | |
| Overrides the display of the specified field name for the given record. | |
| fieldname__format ($value) | |
| Formats the output value of a particular field. In constrast to fieldname__display() this does not take the Dataface_Record as a parameter. As such it can be used to format arbitrary values in a consistent way. If you don't need information from the record when formatting a value for display, it is preferred to use this method since it is more generic. | |
| fieldname__toString (Dataface_Record $record) | |
| Overrides the string value of specified field for a given record. | |
| fieldname__htmlValue (Dataface_Record $record) | |
| Overrides the HTML display value of a field for a given record. | |
| fieldname__parse ($value) | |
| Overrides the parsing behavior for normalizing a field value. This will dictate how values are transformed when being added to the record via setValue() | |
| fieldname__serialize ($value) | |
| Serializes a field value to prepare it for insertion into an SQL query. | |
| fieldname__default () | |
| Returns the default value for a specified field when new records are inserted. | |
| fieldname__link (Dataface_Record $record) | |
| Provides a link to obtain more information about a field on the edit form. | |
| fieldname__pushValue (Dataface_Record $record, HTML_QuickForm_element $el) | |
| Retrieves the field value from a form widget in a format that can be inserted into a record using the Dataface_Record::setValue() method. | |
| fieldname__pullValue (Dataface_Record $record, HTML_QuickForm_element $el) | |
| Retrieves the value for a field from a record in a format that can be set in a form widget. | |
Calculated Fields | |
| field__fieldname (Dataface_Record $record) | |
| Defines a calculated field that can be used just like any other field in the table. | |
Record Triggers | |
| beforeSave (Dataface_Record $record) | |
| Trigger called before a record is saved. | |
| afterSave (Dataface_Record $record) | |
| Trigger called after a record is saved. | |
| beforeInsert (Dataface_Record $record) | |
| Trigger called before a record is inserted into the database for the first time. | |
| afterInsert (Dataface_Record $record) | |
| Trigger called after a record is inserted into the database for the first time. | |
| beforeUpdate (Dataface_Record $record) | |
| Trigger called before a record is updated. | |
| afterUpdate (Dataface_Record $record) | |
| Trigger called after a record is updated. | |
| beforeDelete (Dataface_Record $record) | |
| Trigger called before a record is deleted. | |
| afterDelete (Dataface_Record $record) | |
| Trigger called after a record is deleted. | |
| beforeAddExistingRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called before an "existing" related record is added to a relationship. | |
| afterAddExistingRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called after an "existing" related record is added to a relationship. | |
| beforeAddNewRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called before a "new" related record is added to a relationship. | |
| afterAddNewRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called after a "new" related record is added to a relationship. | |
| beforeAddRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called before a related record is added to a relationship (either new or existing). | |
| afterAddRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called after a related record is added to a relationship (either new or existing). | |
| beforeRemoveRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called after a related record is removed from a relationship. | |
| afterRemoveRelatedRecord (Dataface_RelatedRecord $record) | |
| Trigger called after a related record is removed from a relationship. | |
| afterCopy (Dataface_Record $original, Dataface_Record $copy) | |
| Trigger called after a record is copied. | |
Action Triggers | |
| after_action_edit ($params=array()) | |
| Trigger fired after the 'edit' action has completed successfully. | |
| after_action_new ($params=array()) | |
| Trigger fired after the 'new' action has completed successfully. | |
| after_action_delete () | |
| Trigger fired after the 'delete' action has completed successfully. | |
Template Customization | |
| block__blockname (array $params=array()) | |
| Fills a block or slot in a template when operating in the context of the delegate class's table. | |
List Tab Cutomization | |
| fieldname__renderCell (Dataface_Record $record) | |
| Overrides the display of a table cell for a field in list view. | |
| renderRow () | |
| Overrides the display of a table row in list view. | |
| renderRowHeader (Dataface_Record $record) | |
| Overrides the headings row for the list view table. | |
View Tab Customization | |
| section__sectionname (Dataface_Record $record) | |
| Defines a new section on the view tab. | |
Full-text Search | |
| getSearchableText (Dataface_Record $record) | |
| Returns the indexable text to be used for the full-text site search feature. | |
RSS Feed Customization | |
| getFeedItem (Dataface_Record $record) | |
| Returns a data structure with the contents to be included in the RSS feed. | |
| getFeed (array $query) | |
| Returns data structure with settings for the RSS feed as a whole. | |
| getFeedSource (array $query) | |
| Returns the source URL for the RSS feed that is generated by the given query. | |
| getRelatedFeed (Dataface_Record $record, $relationship) | |
| Returns details about a feed of related records. This overrides the feed details for related feeds. | |
| getRSSDescription (Dataface_Record $record) | |
| Overrides the description or body of a record as it is displayed in an RSS feed. | |
XML Output Customization | |
| toXML (Dataface_Record $record) | |
| Overrides the XML output of a record as it would appear in Xataface's export_xml action. | |
| getXMLHead (Dataface_Record $record) | |
| Returns XML content to be included at the beginning of the XML representation of this record. | |
| xmlTail (Dataface_Record $record) | |
| Returns XML content to be included at the end of the XML representation of this record. | |
Valuelist Customization | |
| valuelist__valuelistname () | |
| Defines a valuelist on the table. | |
Importing Records | |
| __import__filtername ($data, array $defaults) | |
| Defines an import filter that can be used to import records into the table. | |
Table Settings | |
| __sql__ () | |
| Defines an SQL query that should be used for loading data from this table. | |
Form Validation | |
| fieldname__validate (Dataface_Record $record, $value, array &$params) | |
| Validates form input for a field. | |
Definition at line 10 of file DelegateClass.php.
1.7.4
