[CI] Add Doctum build

drush-ops · May 31, 2024 · 5a25a28 · 5a25a28
1 parent 6098479
commit 5a25a28
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 62 deletions.
diff --git a/api/Drush/Drupal/Commands/sql.html b/api/Drush/Drupal/Commands/sql.html
@@ -84,41 +84,14 @@ <h1>Drush\Drupal\Commands\sql</h1>
     </div>
 
 
-            <h2>Classes</h2>
-    <div class="container-fluid underlined">
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../Drush/Drupal/Commands/sql/SanitizeCommands.html"><abbr title="Drush\Drupal\Commands\sql\SanitizeCommands">SanitizeCommands</abbr></a>    </div>
-                <div class="col-md-6"></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../Drush/Drupal/Commands/sql/SanitizeCommentsCommands.html"><abbr title="Drush\Drupal\Commands\sql\SanitizeCommentsCommands">SanitizeCommentsCommands</abbr></a>    </div>
-                <div class="col-md-6"><p>This class is a good example of a sql-sanitize plugin.</p></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../Drush/Drupal/Commands/sql/SanitizeSessionsCommands.html"><abbr title="Drush\Drupal\Commands\sql\SanitizeSessionsCommands">SanitizeSessionsCommands</abbr></a>    </div>
-                <div class="col-md-6"><p>This class is a good example of how to build a sql-sanitize plugin.</p></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../Drush/Drupal/Commands/sql/SanitizeUserFieldsCommands.html"><abbr title="Drush\Drupal\Commands\sql\SanitizeUserFieldsCommands">SanitizeUserFieldsCommands</abbr></a>    </div>
-                <div class="col-md-6"><p>This class is a good example of how to build a sql-sanitize plugin.</p></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../Drush/Drupal/Commands/sql/SanitizeUserTableCommands.html"><abbr title="Drush\Drupal\Commands\sql\SanitizeUserTableCommands">SanitizeUserTableCommands</abbr></a>    </div>
-                <div class="col-md-6"><p>A sql-sanitize plugin.</p></div>
-            </div>
-            </div>
+
             <h2>Interfaces</h2>
     <div class="container-fluid underlined">
                     <div class="row">
                 <div class="col-md-6">
                                             <em><a href="../../../Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em>
-                        </div>
-                <div class="col-md-6"><p>Implement this interface when building a Drush sql-sanitize plugin.</p></div>
+                        <small><span class="label label-danger">deprecated</span></small></div>
+                <div class="col-md-6"></div>
             </div>
             </div>
 

diff --git a/api/Drush/Drupal/Commands/sql/SanitizePluginInterface.html b/api/Drush/Drupal/Commands/sql/SanitizePluginInterface.html
@@ -80,21 +80,26 @@
         </div>
                 <div id="page-content">
     <div class="page-header">
-        <h1>SanitizePluginInterface    
+        <h1>SanitizePluginInterface    <small><span class="label label-danger">deprecated</span></small>
             </h1>
     </div>
 
 
     <p>        interface
-    <strong>SanitizePluginInterface</strong>        (<a href="https://github.com/drush-ops/drush/blob/12.x/src/Drupal/Commands/sql/SanitizePluginInterface.php">View source</a>)
+    <strong>SanitizePluginInterface</strong>        (<a href="https://github.com/drush-ops/drush/blob/13.x/src/Drupal/Commands/sql/SanitizePluginInterface.php">View source</a>)
 </p>
 
 
+            <p>
+                <small><span class="label label-danger">deprecated</span></small>
+                            <tr>
+                    <td>use</td>
+                    <td>\Drush\Commands\sql\sanitize\SanitizePluginInterface instead.</td>
+                </tr>
+                    </p>
 
 
 
-            <div class="description">
-            <p><p>Implement this interface when building a Drush sql-sanitize plugin.</p></p>                    </div>
 
 
 
@@ -109,17 +114,19 @@ <h2>Methods</h2>
                 <div class="col-md-8">
                     <a href="#method_sanitize">sanitize</a>($result, <abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr> $commandData)
 
-                                            <p><p>Run your sanitization logic using standard Drupal APIs.</p></p>                </div>
+                                            <p class="no-description">No description</p>
+                                    </div>
                 <div class="col-md-2"></div>
             </div>
                     <div class="row">
                 <div class="col-md-2 type">
-                    string[]
+
                 </div>
                 <div class="col-md-8">
                     <a href="#method_messages">messages</a>(array $messages, <abbr title="Symfony\Component\Console\Input\InputInterface">InputInterface</abbr> $input)
 
-                                            <p><p>Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]</p></p>                </div>
+                                            <p class="no-description">No description</p>
+                                    </div>
                 <div class="col-md-2"></div>
             </div>
             </div>
@@ -130,7 +137,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method_sanitize">
-        <div class="location"><a href="https://github.com/drush-ops/drush/blob/12.x/src/Drupal/Commands/sql/SanitizePluginInterface.php#L24">at line 24</a></div>
+        <div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Drupal/Commands/sql/SanitizePluginInterface.php#L15">at line 15</a></div>
         <code>                    
     <strong>sanitize</strong>($result, <abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr> $commandData)
         </code>
@@ -140,7 +147,8 @@ <h3 id="method_sanitize">
 
 
         <div class="method-description">
-                            <p><p>Run your sanitization logic using standard Drupal APIs.</p></p>                        
+                            <p class="no-description">No description</p>
+
         </div>
         <div class="tags">
                             <h4>Parameters</h4>
@@ -149,13 +157,12 @@ <h4>Parameters</h4>
                     <tr>
                 <td></td>
                 <td>$result</td>
-                <td><p>Exit code from the main operation for sql-sanitize.</p></td>
+                <td></td>
             </tr>
                     <tr>
                 <td><abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr></td>
                 <td>$commandData</td>
-                <td><p>Information about the current request.</p>
-<p>Use <code>#[CLI\Hook(type: HookManager::POST_COMMAND_HOOK, target: SanitizeCommands::SANITIZE)]</code></p></td>
+                <td></td>
             </tr>
             </table>
 
@@ -169,8 +176,8 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_messages">
-        <div class="location"><a href="https://github.com/drush-ops/drush/blob/12.x/src/Drupal/Commands/sql/SanitizePluginInterface.php#L35">at line 35</a></div>
-        <code>                    string[]
+        <div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Drupal/Commands/sql/SanitizePluginInterface.php#L16">at line 16</a></div>
+        <code>                    
     <strong>messages</strong>(array $messages, <abbr title="Symfony\Component\Console\Input\InputInterface">InputInterface</abbr> $input)
         </code>
     </h3>
@@ -179,7 +186,8 @@ <h3 id="method_messages">
 
 
         <div class="method-description">
-                            <p><p>Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]</p></p>                        
+                            <p class="no-description">No description</p>
+
         </div>
         <div class="tags">
                             <h4>Parameters</h4>
@@ -188,25 +196,16 @@ <h4>Parameters</h4>
                     <tr>
                 <td>array</td>
                 <td>$messages</td>
-                <td><p>An array of messages to show during confirmation.</p></td>
+                <td></td>
             </tr>
                     <tr>
                 <td><abbr title="Symfony\Component\Console\Input\InputInterface">InputInterface</abbr></td>
                 <td>$input</td>
-                <td><p>The effective commandline input for this request.</p></td>
+                <td></td>
             </tr>
             </table>
 
 
-                            <h4>Return Value</h4>
-
-                    <table class="table table-condensed">
-        <tr>
-            <td>string[]</td>
-            <td><p>An array of messages.</p></td>
-        </tr>
-    </table>
-
 
 
 

diff --git a/api/classes.html b/api/classes.html
@@ -794,6 +794,12 @@ <h1>Classes</h1>
                 <div class="col-md-6">
                     <a href="Drush/DrupalFinder/DrushDrupalFinder.html"><abbr title="Drush\DrupalFinder\DrushDrupalFinder">DrushDrupalFinder</abbr></a>    </div>
                 <div class="col-md-6"><p>A replacement for DrupalFinder. We may go back to that once it uses InstalledVersions from Composer.</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                                            <em><a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em>
+                        <small><span class="label label-danger">deprecated</span></small></div>
+                <div class="col-md-6"></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">

diff --git a/api/doc-index.html b/api/doc-index.html
@@ -1907,7 +1907,9 @@ <h2 id="letterA">A</h2>
 <abbr title="Drush\Commands\sql\sanitize\SanitizeUserFieldsCommands">SanitizeUserFieldsCommands</abbr>::messages</a>() &mdash; <em>Method in class <a href="Drush/Commands/sql/sanitize/SanitizeUserFieldsCommands.html"><abbr title="Drush\Commands\sql\sanitize\SanitizeUserFieldsCommands">SanitizeUserFieldsCommands</abbr></a></em></dt>
                     <dd><p>Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]</p></dd><dt><a href="Drush/Commands/sql/sanitize/SanitizeUserTableCommands.html#method_messages">
 <abbr title="Drush\Commands\sql\sanitize\SanitizeUserTableCommands">SanitizeUserTableCommands</abbr>::messages</a>() &mdash; <em>Method in class <a href="Drush/Commands/sql/sanitize/SanitizeUserTableCommands.html"><abbr title="Drush\Commands\sql\sanitize\SanitizeUserTableCommands">SanitizeUserTableCommands</abbr></a></em></dt>
-                    <dd><p>Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]</p></dd><dt><a href="Drush/Drupal/Migrate/MigrateEvents.html"><abbr title="Drush\Drupal\Migrate\MigrateEvents">MigrateEvents</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></em></dt>
+                    <dd><p>Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]</p></dd><dt><a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html#method_messages">
+<abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr>::messages</a>() &mdash; <em>Method in class <a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em></dt>
+                    <dd></dd><dt><a href="Drush/Drupal/Migrate/MigrateEvents.html"><abbr title="Drush\Drupal\Migrate\MigrateEvents">MigrateEvents</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></em></dt>
                     <dd><p>Defines the row preparation event for the migration system.</p></dd><dt><a href="Drush/Drupal/Migrate/MigrateExecutable.html"><abbr title="Drush\Drupal\Migrate\MigrateExecutable">MigrateExecutable</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></em></dt>
                     <dd></dd><dt><a href="Drush/Drupal/Migrate/MigrateIdMapFilter.html"><abbr title="Drush\Drupal\Migrate\MigrateIdMapFilter">MigrateIdMapFilter</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></em></dt>
                     <dd><p>Filters the ID map by a source and/or a destination ID list.</p></dd><dt><a href="Drush/Drupal/Migrate/MigrateMessage.html"><abbr title="Drush\Drupal\Migrate\MigrateMessage">MigrateMessage</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></em></dt>
@@ -2505,7 +2507,10 @@ <h2 id="letterA">A</h2>
 <abbr title="Drush\Config\Environment">Environment</abbr>::systemConfigPath</a>() &mdash; <em>Method in class <a href="Drush/Config/Environment.html"><abbr title="Drush\Config\Environment">Environment</abbr></a></em></dt>
                     <dd><p>Return the system configuration path (default: /etc/drush)</p></dd><dt><a href="Drush/Config/Environment.html#method_systemCommandFilePath">
 <abbr title="Drush\Config\Environment">Environment</abbr>::systemCommandFilePath</a>() &mdash; <em>Method in class <a href="Drush/Config/Environment.html"><abbr title="Drush\Config\Environment">Environment</abbr></a></em></dt>
-                    <dd><p>Return the system shared commandfile path (default: /usr/share/drush/commands)</p></dd><dt>$<a href="Drush/Drupal/Migrate/MigrateExecutable.html#property_saveCounters">
+                    <dd><p>Return the system shared commandfile path (default: /usr/share/drush/commands)</p></dd><dt><a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a> &mdash; <em>Class in namespace <a href="Drush/Drupal/Commands/sql.html">Drush\Drupal\Commands\sql</a></em></dt>
+                    <dd></dd><dt><a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html#method_sanitize">
+<abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr>::sanitize</a>() &mdash; <em>Method in class <a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em></dt>
+                    <dd></dd><dt>$<a href="Drush/Drupal/Migrate/MigrateExecutable.html#property_saveCounters">
 <abbr title="Drush\Drupal\Migrate\MigrateExecutable">MigrateExecutable</abbr>#saveCounters</a> &mdash; <em>Property in class <a href="Drush/Drupal/Migrate/MigrateExecutable.html"><abbr title="Drush\Drupal\Migrate\MigrateExecutable">MigrateExecutable</abbr></a></em></dt>
                     <dd><p>Counters of map statuses.</p></dd><dt>$<a href="Drush/Drupal/Migrate/MigrateExecutable.html#property_showTimestamp">
 <abbr title="Drush\Drupal\Migrate\MigrateExecutable">MigrateExecutable</abbr>#showTimestamp</a> &mdash; <em>Property in class <a href="Drush/Drupal/Migrate/MigrateExecutable.html"><abbr title="Drush\Drupal\Migrate\MigrateExecutable">MigrateExecutable</abbr></a></em></dt>

diff --git a/api/doctum-search.json b/api/doctum-search.json
diff --git a/api/doctum.js b/api/doctum.js
diff --git a/api/index.html b/api/index.html
@@ -100,6 +100,8 @@ <h2>Drush</h2>
                                                             <li><a href="Drush/Config/Loader.html">Drush\Config\Loader</a></li>
                                                             <li><a href="Drush/Drupal.html">Drush\Drupal</a></li>
                                                             <li><a href="Drush/DrupalFinder.html">Drush\DrupalFinder</a></li>
+                                                            <li><a href="Drush/Drupal/Commands.html">Drush\Drupal\Commands</a></li>
+                                                            <li><a href="Drush/Drupal/Commands/sql.html">Drush\Drupal\Commands\sql</a></li>
                                                             <li><a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></li>
                                                             <li><a href="Drush/Exceptions.html">Drush\Exceptions</a></li>
                                                             <li><a href="Drush/Exec.html">Drush\Exec</a></li>

diff --git a/api/interfaces.html b/api/interfaces.html
@@ -97,6 +97,12 @@ <h1>Interfaces</h1>
                                             <em><a href="Drush/Commands/sql/sanitize/SanitizePluginInterface.html"><abbr title="Drush\Commands\sql\sanitize\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em>
                         </div>
                 <div class="col-md-6"><p>Implement this interface when building a Drush sql-sanitize plugin.</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                                            <em><a href="Drush/Drupal/Commands/sql/SanitizePluginInterface.html"><abbr title="Drush\Drupal\Commands\sql\SanitizePluginInterface">SanitizePluginInterface</abbr></a></em>
+                        <small><span class="label label-danger">deprecated</span></small></div>
+                <div class="col-md-6"></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">

diff --git a/api/namespaces.html b/api/namespaces.html
@@ -100,6 +100,8 @@ <h2>Drush</h2>
                                                             <li><a href="Drush/Config/Loader.html">Drush\Config\Loader</a></li>
                                                             <li><a href="Drush/Drupal.html">Drush\Drupal</a></li>
                                                             <li><a href="Drush/DrupalFinder.html">Drush\DrupalFinder</a></li>
+                                                            <li><a href="Drush/Drupal/Commands.html">Drush\Drupal\Commands</a></li>
+                                                            <li><a href="Drush/Drupal/Commands/sql.html">Drush\Drupal\Commands\sql</a></li>
                                                             <li><a href="Drush/Drupal/Migrate.html">Drush\Drupal\Migrate</a></li>
                                                             <li><a href="Drush/Exceptions.html">Drush\Exceptions</a></li>
                                                             <li><a href="Drush/Exec.html">Drush\Exec</a></li>

diff --git a/api/renderer.index b/api/renderer.index
diff --git a/api/traits.html b/api/traits.html
@@ -125,7 +125,7 @@ <h1>Traits</h1>
 
                     </div>
                 </div>
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <div class="row">
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <div class="row">
                     <div class="col-md-6">
                         <a href="Drush/Exec/ExecTrait.html"><abbr title="Drush\Exec\ExecTrait">ExecTrait</abbr></a>
                     </div>