README

Base integration of the Ride framework libraries.

This module glues the needed libraries together to get a system with the following features:

• Flexible configuration
• Dependency injection
• Events
• Logging
• Modules
• Host system abstraction

This module is the starting point of the Ride framework. Below this module are libraries, above this module are Ride implementations.

What's In This Application

Libraries

• ride/lib-cache
• ride/lib-common
• ride/lib-dependency
• ride/lib-event
• ride/lib-log
• ride/lib-reflection
• ride/lib-system

Application

The Application interface is to run a service in the system. It's only method is service and is used by the CLI and web modules.

System

The System class is an extension of the same class in the system library. It adds access to the Ride framework and makes the following components available:

• System and configuration parameters
• Dependency injector
• File browser
• Log
• Autoloader

SystemInitializer

The SystemInitializer interface is used to initialize (or boot) the system.

One of the tasks of the system initializer is to add all modules to the file browser and, optionally, the autoloader. Read more about this in manual/Core/Modules.md.

You can add multiple system initializers to your system parameters located in application/config/parameters.php. If none is provided, the ComposerSystemInitializer is used.

DirectorySystemInitializer

The DirectorySystemInitializer class is used to add a custom module directory to the system. All modules inside the provided directory will be added to the file browser and all sources to the autoloader.

ComposerSystemInitializer

The ComposerSystemInitializer class is used to add all modules installed through Composer to the system. You can set a custom modules directory to add modules which are outside of the vendor directory.

Parameters

• log.action: Action level of the log. 0 to disable, 1 to log requests where an error has occured, 2 for warnings, 4 for information messages and 8 for debug messages.
• log.file: Path to the log file.
• log.level: Level of messages to log. 0 for everything, 1 for errors, 2 for warnings, ...
• log.truncate: Maximum size for the log file in kb.
• system.application: Dependency id of the default application
• system.binary.%command%: Full path to a binary command
• system.cache.dependencies: Flag to see if the dependencies should be cached
• system.cache.directory: Path to the directory of the application file cache pool
• system.cache.event: Path to the file name of the event cache
• system.cache.file: Path to the file of the application memory cache pool
• system.directory.user: Path to the directory of user content/uploads
• system.event.loader: Dependency id of the event loader
• system.event.listener.default: Dependency id of the event listener IO in use
• system.event.listener.cache: Dependency id of the cached event listener IO
• system.name: Name of the system, defaults to Ride
• system.secret: Secret key of the system for encryption and security
• system.timezone: Timezone for this application

Related Modules

• ride/app-database
• ride/app-i18n
• ride/app-image
• ride/app-mail
• ride/app-media
• ride/app-orm
• ride/app-template
• ride/app-validation
• ride/cli
• ride/cli-app
• ride/setup-app
• ride/web

Installation

You can use Composer to install this application.

composer require ride/setup-app

or for manual install:

composer require ride/app