Main Page

From FuseWiki

Contents 1 Using FUSE 1.1 Installation 1.2 Configuration 1.3 Controllers 1.4 Data Models 1.5 SQL Query Generation 1.6 Searching data 1.7 Views 1.8 Forms 1.9 Direct Data Access 1.10 URI Routing 1.11 Static Page Caching 1.12 Presentation/Layout 1.13 Authentication 1.14 Photo Handling 1.15 AJAX / BRIJ 1.16 Messages/Message Translation 1.17 Error Handling 1.18 Handling Include Files 1.19 Debugging 1.20 Examples 1.21 Samples 1.22 FAQ 2 API 2.1 Main Classes 2.2 App Configuration 2.3 Photo/Image Management 2.4 User Authentication 2.5 Helpers 2.6 Layout/Presentation 2.7 Exceptions

Using FUSE

Installation

• Click here for installation instructions
• Video Tutorial
• Generating Models, Controllers, and Views

Configuration

• App Configuration Configuring your FUSE application

Controllers

• Controller Basics
• Advanced controller options
• FuseApplicationController class - everything your application does will be an extension of this controller
• FuseDataController class - makes interfacing your data as easy as possible
• Using DataControllerWithImage - allow you to automatically upload and resize an image alongside your data.
• Using FusePhotoController - automatically upload and resize multiple pictures alongside your data
• Authenticating Controller Actions
• Using ControllerMixin - using the ControllerMixin class to apply methods & properties to all controllers in your project

Data Models

• Data Model Creating and using data models
• Data Model Advanced Advanced Data Model methods
• Fetching Data through Models Customizing your queries without writing any SQL.
• Persisting Data through Model How to write data out to the database.

SQL Query Generation

• Using the FuseSQLQuery Object Generating multipart SQL Queries through the FuseSQLQuery object

Searching data

• Searching data - Using FuseDataController's builtin search capabilities

Views

• Views An introduction to creating and using Views (templates)
• Using FuseTemplate The FuseTemplate object, which provides the interface between Controllers and Views.
• Using Helpers Using Helper classes to extend view functionality

Forms

• Form Basics Creating a basic form to add or update table data
• Advanced Form Handling Customizing forms and constraining form data
• Form Selections Generating form <select> inputs directly from data models
• File Uploads Handling File Uploads
• Tinymce Integration Easy TinyMCE integration

Direct Data Access

• FuseDB The FuseDB object, which handles all communication with the DBMS

URI Routing

• URI Routing Using the URI Router to map URIs to Controller methods
• URI Routing Advanced Advanced routing techniques

Static Page Caching

• Static Page Caching - Using the FUSE static cache so that pages do not have to be rendered dynamically when unchanged

Presentation/Layout

• Layout Handling
• Pagination Paginating list data

Authentication

• Authenticating Controller Actions - Using FUSE's user/group permission schemes to allow or disallow access to controller methods
• Controller Authentication Advanced - Additional information on controller authentication
• Creating a custom User class - How to extend the User class to suit your specific application

Photo Handling

• Using DataControllerWithImage - allow you to automatically upload and resize an image alongside your data.
• Using FusePhotoController - automatically upload and resize multiple pictures alongside your data

AJAX / BRIJ

• Using BRIJ Using Fuse BRIJ (AJAX Functionality)

Messages/Message Translation

• Message Translation Using message keys for effective dynamic string handling

Error Handling

• Error Handling Intro An introduction to FUSE error handling

Handling Include Files

• Including models, controllers, and classes by name

Debugging

• Debugging

Examples

• A basic news handler
• Integrating Google Map directions in 5 minutes
• Viewing Data Viewing a record using the view() method

Samples

• Blog Sample A downloadable, functional sample for a blog with comments

FAQ

• Why doesn't my view see some variables?
• URI redirecting / generating
• How do I hide these debug messages?
• isset() doesn't work in controllers when I do isset($this->something)

API

Main Classes

• FuseApplicationController class - everything your application does will be an extension of this controller
• FuseDataModel class - provides an object interface for fetching & updating records from database tables
• FuseDataController class - makes interfacing your data as easy as possible
• FuseDB The FuseDB object, which handles all communication with the DBMS
• FuseSQLQuery Generating multipart SQL Queries through the FuseSQLQuery object
• FuseTemplate The FuseTemplate object, which provides the interface between Controllers and Views.
• FuseURIRouter Handles calling the proper controller and method based on the given URI
• FuseFormValidator Handles form validation
• FuseObjectIterator Iterates a series of objects
• FuseModelIterator Iterates a series of data models

App Configuration

• Config - Global, static Config class used to store configuration options

Photo/Image Management

• DataControllerWithImage - A FuseDataController that also supports automatically associating/resizing an image with a row in the table
• FusePhotoController - A FuseDataController that provides functionality for automatically associating/resizing many images with a given table row
• FusePhotoManager - Handles uploading, resizing, and linking pictures to a row in the database.

User Authentication

• Auth.conf.php - Configuration options for user authentication and session management.
• AuthConstants - Static class that contains constants used by the Auth/ library. You should never need this.
• AuthLoader - Used to load proper user authentication classes based on the settings in AuthConfig
• AuthRedirector - Used to handle login and logout redirection.
• AuthSession - Tracks information about the the active login session
• AuthSessionManager - Static class used to load & access the active AuthSession.
• AuthVarHelper - Static class used to sanity check Auth-related variables/objects
• UserGroup - Data Model used to access user group data
• GroupPreference - Data model used to access groupwide preferences
• GroupPrivilege - Data model used to access groupwide privileges
• User - Data model used to access user information
• UserLogin - Used to process user logins
• UserLogout - Used to process user logouts
• UserPreference - Data model used to access user preferences
• UserPreferenceType - Data model used to access preference types
• UserPrivContextType - Data model used to access privilege contexts
• UserPrivilege - Data model used to access user privileges
• UserPrivilegeType - Data model used to access user privilege types
• UserPrivQueryHelper - Static class used to apply privilege clauses to SQL queries
• UserRestriction - Data model used to access user restrictions

Helpers

• FormDateHelper - Provides functionality for automatically generating date/time inputs for forms. Discussed in Form Selections
• FormOptionsHelper - Provides functionality for automatically generating option inputs for forms. Discussed in Form Selections
• ListHelper - Provides functionality to ease common tasks for displaying lists of data
• JavascriptHelper - Provides functionality for formatting parameters for javascript compatibility
• PaginationHelper - Provides functionality for automatically generating list pagination. Discussed in Pagination.

Layout/Presentation

• Pagination.class.php - The FUSE Pagination class

Exceptions

• ExceptionList - List of available exceptions