function hook_drush_engine_ENGINE_TYPE

8.0.x drush.api.php hook_drush_engine_ENGINE_TYPE()
6.x drush.api.php hook_drush_engine_ENGINE_TYPE()
7.x drush.api.php hook_drush_engine_ENGINE_TYPE()
5.x drush.api.php hook_drush_engine_ENGINE_TYPE()
master drush.api.php hook_drush_engine_ENGINE_TYPE()

Inform drush about one or more engines implementing a given engine type.

  • description: The engine implementation's description.
  • implemented-by: The engine that actually implements this engine. This is useful to allow the implementation of similar engines in the reference one. Defaults to the engine type key (e.g. 'ice-cream').
  • verbose-only: The engine implementation will only appear in help output in --verbose mode.

This hook allow to declare implementations for an engine type.

See also

pm_drush_engine_package_handler()

pm_drush_engine_version_control()

File

./drush.api.php, line 387
Documentation of the Drush API.

Code

function hook_drush_engine_ENGINE_TYPE() {
  return array(
    'ice-cream' => array(
      'description' => 'Feature rich ice-cream with all kind of additives.',
      'options' => array(
        'flavour' => 'Choose your favorite flavour',
      ),
    ),
    'frozen-yogurt' => array(
      'description' => 'Frozen dairy dessert made with yogurt instead of milk and cream.',
      'implemented-by' => 'ice-cream',
    ),
  );
}