summaryrefslogtreecommitdiffstats
path: root/provision.api.php
diff options
context:
space:
mode:
authorNeil Drumm2010-06-16 23:06:07 (GMT)
committerNeil Drumm2010-06-16 23:06:07 (GMT)
commitfb76276058b08149dd876a29adfde1b9e5024e89 (patch)
treebb107660b1d8e1648e9f4671d98ec20743e09959 /provision.api.php
parentdf4f4e26e5fe47edddc2b2d3ac310ffe1f2d6b98 (diff)
Documentatation
Diffstat (limited to 'provision.api.php')
-rw-r--r--provision.api.php92
1 files changed, 92 insertions, 0 deletions
diff --git a/provision.api.php b/provision.api.php
new file mode 100644
index 0000000..02b7c6f
--- /dev/null
+++ b/provision.api.php
@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * @file Provision API
+ *
+ * @see drush.api.php
+ * @see drush_command_invoke_all
+ */
+
+
+/**
+ * Advertise what service types are available and their default
+ * implementations. Services are class provisionService_{type}_{service} in
+ * {type}/{service}/{service}_service.inc files.
+ *
+ * @return
+ * An associative array of type => default. Default may be NULL.
+ *
+ * @see provision.service.inc
+ */
+function drush_hook_provision_services() {
+ return array('db' => NULL);
+}
+
+/**
+ * Append PHP code to Drupal's settings.php file.
+ *
+ * To use templating, return an include statement for the template.
+ *
+ * @param $uri
+ * URI for the site.
+ * @param $data
+ * Associatiave array of data from provisionConfig_drupal_settings::data.
+ *
+ * @return
+ * Lines to add to the site's settings.php file.
+ *
+ * @see provisionConfig_drupal_settings
+ */
+function drush_hook_provision_drupal_config($uri, $data) {
+ return '$conf[\'reverse_proxy\'] = TRUE;';
+}
+
+/**
+ * Append Apache configuration to server configuration.
+ *
+ * To use templating, return an include statement for the template.
+ *
+ * @param $data
+ * Associatiave array of data from provisionConfig_apache_server::data.
+ *
+ * @return
+ * Lines to add to the configuration file.
+ *
+ * @see provisionConfig_apache_server
+ */
+function drush_hook_provision_apache_server_config($data) {
+}
+
+/**
+ * Append Apache configuration to platform configuration.
+ *
+ * To use templating, return an include statement for the template.
+ *
+ * @param $data
+ * Associatiave array of data from provisionConfig_apache_platform::data.
+ *
+ * @return
+ * Lines to add to the configuration file.
+ *
+ * @see provisionConfig_apache_platform
+ */
+function drush_hook_provision_apache_dir_config($data) {
+}
+
+/**
+ * Append Apache configuration to site vhost configuration.
+ *
+ * To use templating, return an include statement for the template.
+ *
+ * @param $uri
+ * URI for the site.
+ * @param $data
+ * Associatiave array of data from provisionConfig_apache_site::data.
+ *
+ * @return
+ * Lines to add to the configuration file.
+ *
+ * @see provisionConfig_apache_site
+ */
+function drush_hook_provision_apache_vhost_config($uri, $data) {
+}