Reference

Owned by Geoff Bowers
Last updated: Jul 01, 2010Version comment

The FarCry framework has a vast array of functionality under the hood. The Reference section is a series of cheat sheets detailing the various configuration options, attributes and conventions of various aspects of the framework.

References
  • Anatomy of a Project — FarCry proscribes a specific layout for code, how it should be stored and where specific types of function should be located in your project. The project is in effect your application and is the final arbitrator in terms of what gets included in your running application.
  • Event Hooks — Several kinds of features and functionality need to hook into certain events. Examples of an existing hook is the types.afterSave function which allows a developer to run their own code in the event of a save, without mucking about with setData.
  • Security Model — FarCry has its own in-built, roles based security model that is leveraged by the framework, and custom applications.
  • Navigation Folder Options
  • Internationalisation (i18n) — The webtop and COAPI (meaning all forms that use formtools) have been updated so that every label and description is translated.
  • Summary of View or Webskin Decorators — A view decorator is a little bit of metadata that you can stick at the top of your view in FarCry to change its behaviour and the way its documented. FarCry Core framework is pretty clever and can work out a default in most cases depending on the file naming convention you have used. However, its good practice to be explicit about your decorators so be sure to put them in.
  • Client Side Validation — The standard formtool library leverages Jörn Zaefferer's jQuery Validation Plugin.
  • Cache Headers
  • Error Pages
  • Database Gateway API — FarCry 6.1 presents a completely refactored database layer. The goal is to make the layer more distinct so that implementing a gateway CFC is enough to add support for a database to FarCry.
  • Content Type Component Metadata
  • Mobile and Tablet Specific Webskins
  • Varnish Web Accelerator
  • Webskin or View Post Processing — Ever wanted to just add a link to a YouTube or Vimeo video in your content and have the system convert it to the right embed code? How about a Tweet, or a Gist?  If the embed changes (or your design changes!) how cool would it be to just update a central location and have all your embeds update?
  • Working With CDNs — CDN functionality provides the ability to store and serve content managed files (e.g. CSS, images, etc) from somewhere other than the application server itself.