www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/src/Commands/core/DocsCommands.php

   1 <?php
   2 namespace Drush\Commands\core;
   3
   4 use Drush\Commands\DrushCommands;
   5
   6 /**
   7  * Topic commands.
   8  * Any commandfile may add topics.
   9  * Set 'topic' => TRUE to indicate the command is a topic (REQUIRED)
  10  * Begin the topic name with the name of the commandfile (just like
  11  * any other command).
  12  */
  13 class DocsCommands extends DrushCommands
  14 {
  15     /**
  16      * README.md
  17      *
  18      * @command docs:readme
  19      * @aliases docs-readme
  20      * @hidden
  21      * @topic
  22      */
  23     public function readme()
  24     {
  25         self::printFile(DRUSH_BASE_PATH. '/README.md');
  26     }
  27
  28     /**
  29      * Drush's support for Git Bisect.
  30      *
  31      * @command docs:bisect
  32      * @aliases docs-bisect
  33      * @hidden
  34      * @topic
  35      */
  36     public function bisect()
  37     {
  38         self::printFile(DRUSH_BASE_PATH. '/examples/git-bisect.example.sh');
  39     }
  40
  41     /**
  42      * Bashrc customization examples for Drush.
  43      *
  44      * @command docs:bashrc
  45      * @aliases docs-bashrc
  46      * @hidden
  47      * @topic
  48      */
  49     public function bashrc()
  50     {
  51         self::printFile(DRUSH_BASE_PATH. '/examples/example.bashrc');
  52     }
  53
  54     /**
  55      * Configuration overview with examples from example.drush.yml.
  56      *
  57      * @command docs:configuration
  58      * @aliases docs-configuration
  59      * @hidden
  60      * @topic
  61      */
  62     public function config()
  63     {
  64         self::printFile(DRUSH_BASE_PATH. '/examples/example.drush.yml');
  65     }
  66
  67     /**
  68      * Drupal config export instructions, including customizing config by environment.
  69      *
  70      * @command docs:config:exporting
  71      * @aliases docs-config-exporting
  72      * @hidden
  73      * @topic
  74      */
  75     public function configExport()
  76     {
  77         self::printFile(DRUSH_BASE_PATH. '/docs/config-exporting.md');
  78     }
  79
  80     /**
  81      * Creating site aliases for running Drush on remote sites.
  82      *
  83      * @command docs:aliases
  84      * @aliases docs-aliases
  85      * @hidden
  86      * @topic
  87      */
  88     public function siteAliases()
  89     {
  90         self::printFile(DRUSH_BASE_PATH. '/examples/example.site.yml');
  91     }
  92
  93     /**
  94      * Bootstrap explanation: how Drush starts up and prepares the Drupal environment.
  95      *
  96      * @command docs:bootstrap
  97      * @aliases docs-bootstrap
  98      * @hidden
  99      * @topic
 100      */
 101     public function bootstrap()
 102     {
 103         self::printFile(DRUSH_BASE_PATH. '/docs/bootstrap.md');
 104     }
 105
 106     /**
 107      * Crontab instructions for running your Drupal cron tasks via `drush cron`.
 108      *
 109      * @command docs:cron
 110      * @aliases docs-cron
 111      * @hidden
 112      * @topic
 113      */
 114     public function cron()
 115     {
 116         self::printFile(DRUSH_BASE_PATH. '/docs/cron.md');
 117     }
 118
 119     /**
 120      * Instructions on creating your own Drush commands.
 121      *
 122      * @command docs:commands
 123      * @aliases docs-commands
 124      * @hidden
 125      * @topic
 126      */
 127     public function commands()
 128     {
 129         self::printFile(DRUSH_BASE_PATH. '/docs/commands.md');
 130     }
 131
 132     /**
 133      * Instructions on creating your own Drush Generators.
 134      *
 135      * @command docs:generators
 136      * @aliases docs-generators
 137      * @hidden
 138      * @topic
 139      */
 140     public function generators()
 141     {
 142         self::printFile(DRUSH_BASE_PATH. '/docs/generators.md');
 143     }
 144
 145     /**
 146      * Example Drush command file.
 147      *
 148      * @command docs:examplecommand
 149      * @aliases docs-examplecommand
 150      * @hidden
 151      * @topic
 152      */
 153     public function exampleCommand()
 154     {
 155         self::printFile(DRUSH_BASE_PATH. '/examples/Commands/ArtCommands.php');
 156     }
 157
 158     /**
 159      * Extend sql-sync to allow transfer of the sql dump file via http.
 160      *
 161      * @command docs:example-sync-via-http
 162      * @aliases docs-example-sync-via-http
 163      * @hidden
 164      * @topic
 165      */
 166     public function syncHttp()
 167     {
 168         self::printFile(DRUSH_BASE_PATH. '/examples/Commands/SyncViaHttpCommands.php');
 169     }
 170
 171     /**
 172      * Example policy file.
 173      *
 174      * @command docs:policy
 175      * @aliases docs-policy
 176      * @hidden
 177      * @topic
 178      */
 179     public function policy()
 180     {
 181         self::printFile(DRUSH_BASE_PATH. '/examples/Commands/PolicyCommands.php');
 182     }
 183 }