Chapter 3.  User Defined Modules and Classes

Table of Contents

Module: <Toplevel Module>
Overview
Constants
Instance Attributes
Instance Methods
Module: Forwardable (<Toplevel Module>)
Overview
Class: OpenStruct (<Toplevel Module>)
Overview
Module: ActionController (<Toplevel Module>)
Overview
Class: Base (ActionController)
Overview
Module: UrlWriter (ActionController)
Overview
Module: ActiveRecord (<Toplevel Module>)
Overview
Class: Base (ActiveRecord)
Overview
Class Methods
Class: Migrator (ActiveRecord)
Overview
Class: Observer (ActiveRecord)
Overview
Class: ActiveRecordError (ActiveRecord)
Overview
Class: Rollback (ActiveRecord)
Overview
Module: Rails (<Toplevel Module>)
Overview
Module Methods
Class: Configuration (Rails)
Overview
Class: Initializer (Rails)
Overview
Module: Generator (Rails)
Overview
Class: Base (Rails::Generator)
Overview
Class: NamedBase (Rails::Generator)
Overview
Module: Commands (Rails::Generator)
Overview
Class: Base (Rails::Generator::Commands)
Overview
Class: Create (Rails::Generator::Commands)
Overview
Instance Methods
Class: ControllerGenerator (<Toplevel Module>)
Overview
Class: ModelGenerator (<Toplevel Module>)
Overview
Class: MigrationGenerator (<Toplevel Module>)
Overview
Class: MailerGenerator (<Toplevel Module>)
Overview
Module: WillPaginate (<Toplevel Module>)
Overview
Class: LinkRenderer (WillPaginate)
Overview
Module: ViewHelpers (WillPaginate)
Overview
Module: Radius (<Toplevel Module>)
Overview
Class: Context (Radius)
Overview
Module: ActiveResource (<Toplevel Module>)
Overview
Class: Base (ActiveResource)
Overview
Module: Rack (<Toplevel Module>)
Overview
Module: Cache (Rack)
Overview
Class: MetaStore (Rack::Cache)
Overview
Constants
Class: Disk (Rack::Cache::MetaStore)
Overview
Class: EntityStore (Rack::Cache)
Overview
Constants
Class: Disk (Rack::Cache::EntityStore)
Overview
Module: Admin (<Toplevel Module>)
Overview
Class: ApplicationController (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: SiteController (<Toplevel Module>)
Overview
Class Methods
Instance Methods
Class: ConfigurationController (Admin)
Overview
Instance Methods
Class: ExtensionsController (Admin)
Overview
Instance Methods
Class: LayoutsController (Admin)
Overview
Class: PageFieldsController (Admin)
Overview
Instance Methods
Class: PagePartsController (Admin)
Overview
Instance Methods
Class: PagesController (Admin)
Overview
Instance Methods
Class: PreviewStop (Admin::PagesController)
Overview
Instance Methods
Class: PreferencesController (Admin)
Overview
Instance Methods
Class: ReferencesController (Admin)
Overview
Instance Methods
Class: ResourceController (Admin)
Overview
Class Methods
Instance Aliases
Instance Methods
Class: SnippetsController (Admin)
Overview
Class: UsersController (Admin)
Overview
Instance Methods
Class: WelcomeController (Admin)
Overview
Instance Methods
Module: ApplicationHelper (<Toplevel Module>)
Overview
Instance Methods
Module: SiteHelper (<Toplevel Module>)
Overview
Module: ConfigurationHelper (Admin)
Overview
Instance Methods
Module: ExportHelper (Admin)
Overview
Module: ExtensionsHelper (Admin)
Overview
Module: LayoutsHelper (Admin)
Overview
Instance Methods
Module: NodeHelper (Admin)
Overview
Instance Methods
Module: PagesHelper (Admin)
Overview
Instance Methods
Module: PreferencesHelper (Admin)
Overview
Module: ReferencesHelper (Admin)
Overview
Instance Methods
Module: RegionsHelper (Admin)
Overview
Instance Methods
Module: ResourceHelper (Admin)
Overview
Module: SnippetsHelper (Admin)
Overview
Instance Methods
Module: UsersHelper (Admin)
Overview
Instance Methods
Module: WelcomeHelper (Admin)
Overview
Module: DeprecatedTags (<Toplevel Module>)
Overview
Class: FileNotFoundPage (<Toplevel Module>)
Overview
Instance Methods
Class: Layout (<Toplevel Module>)
Overview
Module: MenuRenderer (<Toplevel Module>)
Overview
Module Functions
Instance Methods
Class: Page (<Toplevel Module>)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: MissingRootPageError (Page)
Overview
Instance Methods
Class: PageContext (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: PageField (<Toplevel Module>)
Overview
Class: PagePart (<Toplevel Module>)
Overview
Instance Methods
Module: Radiant (<Toplevel Module>)
Overview
Constants
Module Methods
Class: Config (Radiant)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: ConfigError (Radiant::Config)
Overview
Class: Snippet (<Toplevel Module>)
Overview
Instance Methods
Module: StandardTags (<Toplevel Module>)
Overview
Instance Methods
Class: TagError (StandardTags)
Overview
Class: RequiredAttributeError (StandardTags)
Overview
Class: Status (<Toplevel Module>)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: TextFilter (<Toplevel Module>)
Overview
Class Methods
Instance Methods
Class: User (<Toplevel Module>)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: UserActionObserver (<Toplevel Module>)
Overview
Class Methods
Instance Methods
Module: Version (Radiant)
Overview
Constants
Module Aliases
Module Methods
Class: Configuration (Radiant)
Overview
Instance Attributes
Instance Methods
Class: Initializer (Radiant)
Overview
Class Methods
Instance Methods
Class: Setup (Radiant)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: AdminUI (Radiant)
Overview
Instance Attributes
Instance Methods
Class: DuplicateTabNameError (Radiant::AdminUI)
Overview
Class: NavTab (Radiant::AdminUI)
Overview
Instance Aliases
Instance Attributes
Instance Methods
Class: NavSubItem (Radiant::AdminUI)
Overview
Instance Attributes
Instance Methods
Class: RegionPartials (Radiant::AdminUI)
Overview
Instance Methods
Class: RegionSet (Radiant::AdminUI)
Overview
Instance Methods
Module: AvailableLocales (Radiant)
Overview
Module Methods
Module: Cache (Radiant)
Overview
Module Methods
Class: EntityStore (Radiant::Cache)
Overview
Instance Methods
Class: MetaStore (Radiant::Cache)
Overview
Instance Methods
Class: Definition (Radiant::Config)
Overview
Instance Attributes
Instance Methods
Module: Registry (<Toplevel Module>)
Overview
Class: Extension (Registry)
Overview
Instance Methods
Class: Action (Registry)
Overview
Instance Methods
Class: Installer (Registry)
Overview
Instance Attributes
Instance Methods
Class: Uninstaller (Registry)
Overview
Instance Attributes
Instance Methods
Class: Checkout (Registry)
Overview
Instance Methods
Class: Download (Registry)
Overview
Instance Methods
Class: Git (Registry)
Overview
Instance Methods
Class: Subversion (Registry)
Overview
Instance Methods
Class: Gem (Registry)
Overview
Instance Methods
Class: Tarball (Registry)
Overview
Instance Methods
Class: Gzip (Registry)
Overview
Instance Methods
Class: Bzip2 (Registry)
Overview
Instance Methods
Class: Zip (Registry)
Overview
Instance Methods
Class: Extension (Radiant)
Overview
Class Aliases
Class Methods
Instance Aliases
Instance Attributes
Instance Methods
Module: Script (Radiant::Extension)
Overview
Module Methods
Module: Util (Radiant::Extension::Script)
Overview
Instance Attributes
Instance Methods
Class: Install (Radiant::Extension::Script)
Overview
Instance Methods
Class: Uninstall (Radiant::Extension::Script)
Overview
Instance Methods
Class: Info (Radiant::Extension::Script)
Overview
Instance Methods
Class: Help (Radiant::Extension::Script)
Overview
Instance Methods
Class: ExtensionLoader (Radiant)
Overview
Class Methods
Instance Aliases
Instance Attributes
Instance Methods
Class: DependenciesObserver (Radiant::ExtensionLoader)
Overview
Instance Attributes
Instance Methods
Class: ExtensionMigrator (Radiant)
Overview
Class Attributes
Class Methods
Instance Methods
Class: ExtensionPath (Radiant)
Overview
Class Methods
Instance Attributes
Instance Methods
Module: Pagination (Radiant)
Overview
Class: LinkRenderer (Radiant::Pagination)
Overview
Instance Methods
Module: Controller (Radiant::Pagination)
Overview
Module Methods
Instance Methods
Module: ResourceResponses (Radiant)
Overview
Module Methods
Instance Methods
Module: InstanceMethods (Radiant::ResourceResponses)
Overview
Instance Methods
Class: Collector (Radiant::ResourceResponses)
Overview
Instance Methods
Class: Response (Radiant::ResourceResponses)
Overview
Instance Attributes
Instance Methods
Module: Taggable (Radiant)
Overview
Module Methods
Instance Methods
Module: ClassMethods (Radiant::Taggable)
Overview
Instance Methods
Module: Util (Radiant::Taggable)
Overview
Module Methods
Class: ExtensionGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: ExtensionControllerGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: ExtensionMailerGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: ExtensionMigrationGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Class: ExtensionModelGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Module: GeneratorBaseExtension (Radiant)
Overview
Module Methods
Instance Methods
Class: InstanceGenerator (<Toplevel Module>)
Overview
Constants
Instance Methods
Class: Boot (Radiant)
Overview
Instance Methods
Class: VendorBoot (Radiant)
Overview
Instance Methods
Class: AppBoot (Radiant)
Overview
Instance Methods
Class: GemBoot (Radiant)
Overview
Instance Methods
Class: LanguageExtensionGenerator (<Toplevel Module>)
Overview
Instance Attributes
Instance Methods
Module: RoutingExtension (Radiant)
Overview
Module Methods
Instance Aliases
Instance Methods
Module: Annotatable (<Toplevel Module>)
Overview
Module Methods
Module: ClassMethods (Annotatable)
Overview
Module Methods
Instance Aliases
Instance Methods
Module: InheritableClassAttributes (<Toplevel Module>)
Overview
Module Aliases
Module Methods
Module: ClassMethods (InheritableClassAttributes)
Overview
Instance Methods
Module: LocalTime (<Toplevel Module>)
Overview
Instance Methods
Module: LoginSystem (<Toplevel Module>)
Overview
Module Methods
Instance Methods
Module: ClassMethods (LoginSystem)
Overview
Instance Methods
Class: MethodObserver (<Toplevel Module>)
Overview
Class Methods
Instance Attributes
Instance Methods
Class: ObserverCannotObserveTwiceError (MethodObserver)
Overview
Instance Methods
Module: Simpleton (<Toplevel Module>)
Overview
Module Methods
Module: ClassMethods (Simpleton)
Overview
Instance Methods
Class: TaskSupport (<Toplevel Module>)
Overview
Class Methods
Class: TranslationSupport (<Toplevel Module>)
Overview
Class Methods

Module: <Toplevel Module>

is modularized into
module: <Built-in Module>   
module: Forwardable   
class: OpenStruct   
module: ActionController   
module: ActiveRecord   
module: Rails   
class: ControllerGenerator   
class: ModelGenerator   
class: MigrationGenerator   
class: MailerGenerator   
module: WillPaginate   
module: Radius   
module: ActiveResource   
module: Rack   
module: Admin   
class: ApplicationController   
class: SiteController   
module: ApplicationHelper   
module: SiteHelper   
module: DeprecatedTags   
class: FileNotFoundPage   
class: Layout   
module: MenuRenderer   
class: Page   
class: PageContext   
class: PageField   
class: PagePart   
module: Radiant   
class: Snippet   
module: StandardTags   
class: Status   
class: TextFilter   
class: User   
class: UserActionObserver   
module: Registry   
class: ExtensionGenerator   
class: ExtensionControllerGenerator   
class: ExtensionMailerGenerator   
class: ExtensionMigrationGenerator   
class: ExtensionModelGenerator   
class: InstanceGenerator   
class: LanguageExtensionGenerator   
module: Annotatable   
module: InheritableClassAttributes   
module: LocalTime   
module: LoginSystem   
class: MethodObserver   
module: Simpleton   
class: TaskSupport   
class: TranslationSupport   
has properties
constant: RADIANT_ROOT   
method: test_truth   
constant: RAILS_ROOT   
constant: RAILS_ENV   
method: path_to / 1   
attribute: cache_timeout [RW]   

Overview

Module Structure

✗ module: <Toplevel Module>
module: <Built-in Module>     
module: Forwardable     
class: OpenStruct     
module: ActionController     
module: ActiveRecord     
module: Rails     
class: ControllerGenerator     
class: ModelGenerator     
class: MigrationGenerator     
class: MailerGenerator     
module: WillPaginate     
module: Radius     
module: ActiveResource     
module: Rack     
module: Admin     
class: ApplicationController     
class: SiteController     
module: ApplicationHelper     
module: SiteHelper     
module: DeprecatedTags     
class: FileNotFoundPage     
class: Layout     
module: MenuRenderer     
class: Page     
class: PageContext     
class: PageField     
class: PagePart     
module: Radiant     
class: Snippet     
module: StandardTags     
class: Status     
class: TextFilter     
class: User     
class: UserActionObserver     
module: Registry     
class: ExtensionGenerator     
class: ExtensionControllerGenerator     
class: ExtensionMailerGenerator     
class: ExtensionMigrationGenerator     
class: ExtensionModelGenerator     
class: InstanceGenerator     
class: LanguageExtensionGenerator     
module: Annotatable     
module: InheritableClassAttributes     
module: LocalTime     
module: LoginSystem     
class: MethodObserver     
module: Simpleton     
class: TaskSupport     
class: TranslationSupport     

Constants

<Toplevel Module>::RADIANT_ROOT

#1 in lib/radiant.rb

RADIANT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), "..")) unless defined? RADIANT_ROOT   

<Toplevel Module>::RAILS_ROOT

#4 in lib/generators/instance/templates/instance_boot.rb

RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)   

<Toplevel Module>::RAILS_ENV

#5 in lib/generators/instance/templates/instance_boot.rb

RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)   

Instance Attributes

<Toplevel Module>#cache_timeout [RW]

#2 in lib/plugins/response_cache_timeout/init.rb