Skip to content

Commit

Permalink
[CI] Add Doctum build
Browse files Browse the repository at this point in the history
  • Loading branch information
@greg-1-anderson @actions-user
greg-1-anderson authored and actions-user committed Jun 21, 2024
1 parent 1948936 commit 4a39518
Show file tree
Hide file tree
Showing 4 changed files with 176 additions and 16 deletions.
176 changes: 165 additions & 11 deletions api/Drush/Commands/core/SiteInstallCommands.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ <h2>Methods</h2>
void
</div>
<div class="col-md-8">
<a href="#method_install">install</a>(array $profile, $options = [&#039;db-url&#039; =&gt; self::REQ, &#039;db-prefix&#039; =&gt; self::REQ, &#039;db-su&#039; =&gt; self::REQ, &#039;db-su-pw&#039; =&gt; self::REQ, &#039;account-name&#039; =&gt; &#039;admin&#039;, &#039;account-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;site-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;account-pass&#039; =&gt; self::REQ, &#039;locale&#039; =&gt; &#039;en&#039;, &#039;site-name&#039; =&gt; &#039;Drush Site-Install&#039;, &#039;site-pass&#039; =&gt; self::REQ, &#039;sites-subdir&#039; =&gt; self::REQ, &#039;config-dir&#039; =&gt; self::REQ, &#039;existing-config&#039; =&gt; false])
<a href="#method_install">install</a>(array $recipeOrProfile, $options = [&#039;db-url&#039; =&gt; self::REQ, &#039;db-prefix&#039; =&gt; self::REQ, &#039;db-su&#039; =&gt; self::REQ, &#039;db-su-pw&#039; =&gt; self::REQ, &#039;account-name&#039; =&gt; &#039;admin&#039;, &#039;account-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;site-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;account-pass&#039; =&gt; self::REQ, &#039;locale&#039; =&gt; &#039;en&#039;, &#039;site-name&#039; =&gt; &#039;Drush Site-Install&#039;, &#039;site-pass&#039; =&gt; self::REQ, &#039;sites-subdir&#039; =&gt; self::REQ, &#039;config-dir&#039; =&gt; self::REQ, &#039;existing-config&#039; =&gt; false])

<p><p>Install Drupal along with modules/themes/configuration/profile.</p></p> </div>
<div class="col-md-2"></div>
Expand All @@ -454,6 +454,36 @@ <h2>Methods</h2>
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8">
<a href="#method_determineRecipeOrProfile">determineRecipeOrProfile</a>($recipeOrProfile, $options)

<p><p>Determine if the passed parameter is a recipe directory, or a profile name.</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">

</div>
<div class="col-md-8">
<a href="#method_isValidProfileName">isValidProfileName</a>(string $profile)

<p><p>Determine whether the provided profile name meets naming conventions.</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8">
<a href="#method_validateRecipe">validateRecipe</a>(string $recipe)

<p><p>Validates a user provided recipe.</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
Expand Down Expand Up @@ -1275,7 +1305,7 @@ <h4>Return Value</h4>
<h3 id="method_install">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L52">at line 52</a></div>
<code> void
<strong>install</strong>(array $profile, $options = [&#039;db-url&#039; =&gt; self::REQ, &#039;db-prefix&#039; =&gt; self::REQ, &#039;db-su&#039; =&gt; self::REQ, &#039;db-su-pw&#039; =&gt; self::REQ, &#039;account-name&#039; =&gt; &#039;admin&#039;, &#039;account-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;site-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;account-pass&#039; =&gt; self::REQ, &#039;locale&#039; =&gt; &#039;en&#039;, &#039;site-name&#039; =&gt; &#039;Drush Site-Install&#039;, &#039;site-pass&#039; =&gt; self::REQ, &#039;sites-subdir&#039; =&gt; self::REQ, &#039;config-dir&#039; =&gt; self::REQ, &#039;existing-config&#039; =&gt; false])
<strong>install</strong>(array $recipeOrProfile, $options = [&#039;db-url&#039; =&gt; self::REQ, &#039;db-prefix&#039; =&gt; self::REQ, &#039;db-su&#039; =&gt; self::REQ, &#039;db-su-pw&#039; =&gt; self::REQ, &#039;account-name&#039; =&gt; &#039;admin&#039;, &#039;account-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;site-mail&#039; =&gt; &#039;admin@example.com&#039;, &#039;account-pass&#039; =&gt; self::REQ, &#039;locale&#039; =&gt; &#039;en&#039;, &#039;site-name&#039; =&gt; &#039;Drush Site-Install&#039;, &#039;site-pass&#039; =&gt; self::REQ, &#039;sites-subdir&#039; =&gt; self::REQ, &#039;config-dir&#039; =&gt; self::REQ, &#039;existing-config&#039; =&gt; false])
</code>
</h3>
<div class="details">
Expand All @@ -1291,7 +1321,7 @@ <h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>array</td>
<td>$profile</td>
<td>$recipeOrProfile</td>
<td></td>
</tr>
<tr>
Expand Down Expand Up @@ -1320,7 +1350,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_taskCallback">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L180">at line 180</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L187">at line 187</a></div>
<code> void
<strong>taskCallback</strong>($install_state)
</code>
Expand Down Expand Up @@ -1357,13 +1387,137 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_determineRecipeOrProfile">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L195">at line 195</a></div>
<code> protected array
<strong>determineRecipeOrProfile</strong>($recipeOrProfile, $options)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Determine if the passed parameter is a recipe directory, or a profile name.</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td></td>
<td>$recipeOrProfile</td>
<td></td>
</tr>
<tr>
<td></td>
<td>$options</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_isValidProfileName">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L229">at line 229</a></div>
<code> protected
<strong>isValidProfileName</strong>(string $profile)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Determine whether the provided profile name meets naming conventions.</p></p> <p><p>We do not check for reserved names; if a profile name <em>might</em> be
valid, we will pass it through to Drupal and let the system tell us
if it is not allowed.</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td>$profile</td>
<td></td>
</tr>
</table>





</div>
</div>

</div>
<div class="method-item">
<h3 id="method_validateRecipe">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L243">at line 243</a></div>
<code> protected bool
<strong>validateRecipe</strong>(string $recipe)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Validates a user provided recipe.</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td>$recipe</td>
<td><p>The path to the recipe to validate.</p></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>bool</td>
<td><p>TRUE if the recipe exists, FALSE if not.</p></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_determineProfile">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L186">at line 186</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L253">at line 253</a></div>
<code> protected <abbr title="Drush\Commands\core\string|bool">string|bool</abbr>
<strong>determineProfile</strong>($profile, $options)
</code>
Expand Down Expand Up @@ -1411,7 +1565,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_hasConfigFiles">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L239">at line 239</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L306">at line 306</a></div>
<code> protected bool
<strong>hasConfigFiles</strong>($config)
</code>
Expand Down Expand Up @@ -1453,7 +1607,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_validate">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L245">at line 245</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L312">at line 312</a></div>
<code> void
<strong>validate</strong>(<abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr> $commandData)
</code>
Expand Down Expand Up @@ -1496,7 +1650,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_pre">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L364">at line 364</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L434">at line 434</a></div>
<code> void
<strong>pre</strong>(<abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr> $commandData)
</code>
Expand Down Expand Up @@ -1538,7 +1692,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getSitesSubdirFromUri">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L460">at line 460</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L530">at line 530</a></div>
<code> protected
<strong>getSitesSubdirFromUri</strong>($root, $uri)
</code>
Expand Down Expand Up @@ -1577,7 +1731,7 @@ <h4>Parameters</h4>
</div>
<div class="method-item">
<h3 id="method_serverGlobals">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L494">at line 494</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L564">at line 564</a></div>
<code> void
<strong>serverGlobals</strong>($drupal_base_url)
</code>
Expand Down Expand Up @@ -1630,7 +1784,7 @@ <h4>See also</h4>
</div>
<div class="method-item">
<h3 id="method_validateConfigDir">
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L534">at line 534</a></div>
<div class="location"><a href="https://github.com/drush-ops/drush/blob/13.x/src/Commands/core/SiteInstallCommands.php#L604">at line 604</a></div>
<code> protected void
<strong>validateConfigDir</strong>(<abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr> $commandData, $directory)
</code>
Expand Down
Loading

0 comments on commit 4a39518

Please sign in to comment.