Configuring your app

If you created your app using Utensils, then that's it. Your application should be setup and ready to run. If you want to make any changes to your configuration, you can make changes to the configuration files.

If you created the app manually, follow these steps to get it configured.

  1. Edit <Application Root>/Application.syrp
    Set your application's name, namespace, and other required information.
  2. Edit <Application Root>/Config/Settings.dev.syrp
    Setup your development environment, including the database connection, domain, and important folder paths.

That's all you need to set for now. Later, you may want to turn on extensions, use controls, or explicitly define your site's structure.

Configuration Files

By default, ActiveWAFL uses Syrup files to store all configuration information. *

The default configuration files can be broken down into these groupings, for discussion's sake.

  • Application (required)
    General application information
    Application.syrp ⁃ Includes.syrp ⁃ LookAndFeel.syrp
  • Environment (required)
    Commonly used environment-specific application settings such as database configurations, file and folder paths, and debug settings.
    Settings.<env>.syrp
  • Mapping
    Map out the Site Sturcture and Api Calls
    SiteStructure.syrp ⁃ ApiCalls.syrp
  • Extensions and Adaptations
    Configure extensions, controls, and locale
    Extensions.syrp ⁃ Controls.syrp ⁃ <language-code>.syrp
  • Build Support
    Ant build script and build-time unit testing configuration
    Build.xml ⁃ PhpUnit.xml
  • Rare Situations
    Settings that normally should not be changed
    Advanced.syrp ⁃ SettingMappings.syrp
* ActiveWafl ships with some 3rd party XML configuration files used by the Build.
Please refer to the vendor's documentation for more information:
Ant Build File Php Unit Configuration

The following table shows the different configuration files.

Category Filename Description Full Path Per Environment Required
Application
Application.syrp High-level information about an application, such as the name of the application and the root namespace to use. <Application Root>/Application.syrp No Yes
Includes.syrp A list of Javascript files to be included at the start of every page load.
Note: The files are all combined into one and minified
<Application Root>/Advanced/Includes.syrp No No
LookAndFeel.syrp A set of high-level properties that define the standard layout, font, and color scheme for the user interface. <Application Root>/Advanced/LookAndFeel.syrp No No
Environment
Settings.<env>.syrp Environment specific settings about an application, mostly folder paths and urls. * <Application Root>/Config/Settings.<env>.syrp Yes Yes
Mapping
ApiCalls.syrp Api definitions. All Api calls must be explicitly mapped from the Api Request to an Api Handler Method. * <Application Root>/Config/Advanced/ApiCalls.syrp No No
SiteStructure.syrp Explicit site structure (SiteAreas and SitePages) defintions <Application Root>/Config/SiteStructure.syrp No No
Extensions and Adaptation
Extensions.syrp Defines and configures the ActiveWafl extensions in use by this application. <Application Root>/Advanced/Extensions.syrp No No
Controls.syrp Defines and configures the ActiveWafl controls in use by this application. <Application Root>/Advanced/Controls.syrp No No
<Language Code>.syrp If your application supports internationalization then you can define a language for one or more locales. <Application Root>/Advanced/Locale/Languages/<Language Code>.syrp No No
Build Support
Build.xml Ant build script. High-level instruction-set for your application's build. * <Application Root>/Advanced/Build/Build.xml No No
PhpUnit.xml PhpUnit and selenium. Unit and integration testing setup. <Application Root>/Advanced/Build/PhpUnit.xml No No
PhpCs.xml ActiveWafl Php coding standard. This defines the rules that will be used when analyzing the application's Php code for quality. <Application Root>/Advanced/Build/PhpCs.xml No No
PhpMd.xml PhpMd settings. Defines a list of rules that will be used when analyzing the application's Php code for qualtiy <Application Root>/Advanced/Build/PhpMd.xml No No
PhpDox.xml PhpDox settings for creating Php documentation for you application. <Application Root>/Advanced/Build/PhpDox.xml No No
Rare Situations
FolderNames.syrp The names of important folders used in the application. <Application Root>/Advanced/FolderNames.Syrp No Yes
SettingsMapping.syrp Controls where the required settings are mapped to internally. <Application Root>/Advanced/SettingsMapping.Syrp No Yes
Many of the configuration file locations are configurable. The file paths provided here are the defaults. It is recommended you leave them in the default location except for in special situations.
For a Php web application, the "build" usually consists of performing code integrity checks, running tests, and deploying your application.

ActiveWafl provides several command-line utilities that can simplify and improve your builds. Also, ActiveWafl applications perform some tasks inheriently that traditionally have been part of the build, such as minification. ActiveWafl applications start with a Build.xml file that is customized for a typical ActiveWafl application.