Updated to Drupal 8.5. Core Media not yet in use.

[yaffs-website] / vendor / drush / drush / src / Commands / core / DocsCommands.php

diff --git a/vendor/drush/drush/src/Commands/core/DocsCommands.php b/vendor/drush/drush/src/Commands/core/DocsCommands.php
new file mode 100644 (file)
index 0000000..f4cc4d2
--- /dev/null
+++ b/vendor/drush/drush/src/Commands/core/DocsCommands.php
@@ -0,0 +1,183 @@
+<?php
+namespace Drush\Commands\core;
+
+use Drush\Commands\DrushCommands;
+
+/**
+ * Topic commands.
+ * Any commandfile may add topics.
+ * Set 'topic' => TRUE to indicate the command is a topic (REQUIRED)
+ * Begin the topic name with the name of the commandfile (just like
+ * any other command).
+ */
+class DocsCommands extends DrushCommands
+{
+    /**
+     * README.md
+     *
+     * @command docs:readme
+     * @aliases docs-readme
+     * @hidden
+     * @topic
+     */
+    public function readme()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/README.md');
+    }
+
+    /**
+     * Drush's support for Git Bisect.
+     *
+     * @command docs:bisect
+     * @aliases docs-bisect
+     * @hidden
+     * @topic
+     */
+    public function bisect()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/git-bisect.example.sh');
+    }
+
+    /**
+     * Bashrc customization examples for Drush.
+     *
+     * @command docs:bashrc
+     * @aliases docs-bashrc
+     * @hidden
+     * @topic
+     */
+    public function bashrc()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/example.bashrc\'');
+    }
+
+    /**
+     * Configuration overview with examples from example.drush.yml.
+     *
+     * @command docs:configuration
+     * @aliases docs-configuration
+     * @hidden
+     * @topic
+     */
+    public function config()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/example.drush.yml');
+    }
+
+    /**
+     * Drupal config export instructions, including customizing config by environment.
+     *
+     * @command docs:config:exporting
+     * @aliases docs-config-exporting
+     * @hidden
+     * @topic
+     */
+    public function configExport()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/docs/config-exporting.md');
+    }
+
+    /**
+     * Creating site aliases for running Drush on remote sites.
+     *
+     * @command docs:aliases
+     * @aliases docs-aliases
+     * @hidden
+     * @topic
+     */
+    public function siteAliases()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/example.site.yml');
+    }
+
+    /**
+     * Bootstrap explanation: how Drush starts up and prepares the Drupal environment.
+     *
+     * @command docs:bootstrap
+     * @aliases docs-bootstrap
+     * @hidden
+     * @topic
+     */
+    public function bootstrap()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/docs/bootstrap.md');
+    }
+
+    /**
+     * Crontab instructions for running your Drupal cron tasks via `drush cron`.
+     *
+     * @command docs:cron
+     * @aliases docs-cron
+     * @hidden
+     * @topic
+     */
+    public function cron()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/docs/cron.md');
+    }
+
+    /**
+     * Instructions on creating your own Drush commands.
+     *
+     * @command docs:commands
+     * @aliases docs-commands
+     * @hidden
+     * @topic
+     */
+    public function commands()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/docs/commands.md');
+    }
+
+    /**
+     * Instructions on creating your own Drush Generators.
+     *
+     * @command docs:generators
+     * @aliases docs-generators
+     * @hidden
+     * @topic
+     */
+    public function generators()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/docs/generators.md');
+    }
+
+    /**
+     * Example Drush command file.
+     *
+     * @command docs:examplecommand
+     * @aliases docs-examplecommand
+     * @hidden
+     * @topic
+     */
+    public function exampleCommand()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/Commands/SandwichCommands.php');
+    }
+
+    /**
+     * Extend sql-sync to allow transfer of the sql dump file via http.
+     *
+     * @command docs:example-sync-via-http
+     * @aliases docs-example-sync-via-http
+     * @hidden
+     * @topic
+     */
+    public function syncHttp()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/Commands/SyncViaHttpCommands.php');
+    }
+
+    /**
+     * Example policy file.
+     *
+     * @command docs:policy
+     * @aliases docs-policy
+     * @hidden
+     * @topic
+     */
+    public function policy()
+    {
+        self::printFile(DRUSH_BASE_PATH. '/examples/Commands/PolicyCommands.php');
+    }
+}