Scorpio Framework for PHP

• Resources

  • Categories
  • News
  • Documentation
  • Tutorials
  • Roadmap

• Links

  • Madagasgar.com
  • SourceForge Project Page
  • Download Releases
  • Bug Tracker
  • Feature Requests
  • API Docs

scorpio.php

A new tool added with since 0.2.0 is scorpio.php. This replaces several of the previous tools - namely generator.php and mvcGenerator.php. The scorpio.php tool is intended to be used for managing, creating and performing other administration tasks during development of a Scorpio based site. The tool uses the cliApplication infrastructure.

The primary roles of the scorpio tool are:

• List available resources
  • Databases (depending on adaptor)
  • Sites (system registered websites)
  • Site Plugins / Components (system registered website plugins)
• Create new objects within the system
  • Data Access Objects
  • Websites
  • Plugins
  • Website Controllers
  • Test Cases
• Extract data from resources
  • Text for translations (either functions or tag based)
  • Autoload data for building cache files
  • Build bootstrap files - compiled files that contain core classes
• Delete resources
  • Website caches

Each action is handled by a separate command script that can be separately deployed if necessary. In keeping with the revised CLI system, each component has extensive help that can be accessed by first running the script without any arguments or with -h or help. Help for individual actions is then accessed from help . For further commands, help can be accessed by using: help . Accessing the help will list how the command should be executed, any summary information and then the list or arguments or sub-commands that the action supports.

For example scorpio.php help list will give:

Application Help System for scorpio -> help list
--------------------------------------------------------------------------------

Command:
scorpio.php list

Summary:
Lists objects or items of the specified type

Arguments:
      database [all|]
                      Lists available databases using the current database
                      config.
      sites           Lists the currently defined sites in the system
      plugins         Lists all the defined plugins (components) configured in
                      the system


Notes:
--------------------------------------------------------------------------------
The order of commands is important. They are processed in the order they appear.
Ensure all switch commands are placed before actual commands. Aliases (switches)
are always processed before commands

 

Where database has additional options, so help list database can also be run:

Application Help System for scorpio -> help list database
--------------------------------------------------------------------------------

Command:
scorpio.php list database

Summary:
Lists available databases using the current database config.

Arguments:
      all             Lists all databases available in the current config
                      (optional)
       A specific database name to view properties of (optional)


Notes:
--------------------------------------------------------------------------------
The order of commands is important. They are processed in the order they appear.
Ensure all switch commands are placed before actual commands. Aliases (switches)
are always processed before commands

 

There are additional tools for performing other actions such as database updates and running test cases.

< Return to article