Add Wireframe::createDirectories() method

Author: teppokoivula

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.30.0] - 2024-12-01
+
+### Added
+- New method Wireframe::createDirectories() for adding Wireframe directories in code.
+
 ## [0.29.2] - 2024-05-30
 
 ### Fixed

Wireframe.module.php

@@ -14,7 +14,7 @@
  * @method static string|Page|NullPage page($source, $args = []) Static getter (factory) method for Pages.
  * @method static string|null partial(string $partial_name, array $args = []) Static getter (factory) method for Partials.
  *
- * @version 0.29.2
+ * @version 0.30.0
  * @author Teppo Koivula <teppo@wireframe-framework.com>
  * @license Mozilla Public License v2.0 https://mozilla.org/MPL/2.0/
  */
@@ -1145,4 +1145,86 @@ public function getController(?Page $page = null, ?string $template_name = null)
         return null;
     }
 
+    /**
+     * Create directories
+     *
+     * This method is used for creating directories used by Wireframe. It's called from the module configuration screen,
+     * but can also be called in code if needed.
+     *
+     * @param array|null $keys Optional array of keys to create directories for, leave blank to create all directories.
+     * @return array Array of existing directories.
+     *
+     * @throws WireException if no directories are found.
+     * @throws WireException if an invalid path key is provided.
+     * @throws WireException if a directory can't be created.
+     */
+    public function createDirectories(?array $keys = null): array {
+
+        $paths = $this->getDirectoryPaths();
+        if (empty($paths)) {
+            throw new WireException(
+                $this->_('No directories found, possible configuration error. Please check your site config.')
+            );
+        }
+
+        $keys = $keys ?? array_keys((array) $paths);
+        $dirs = [];
+
+        foreach ($keys as $key) {
+            $path = $paths->$key ?? null;
+            if ($path === null) {
+                throw new WireException(sprintf(
+                    $this->_('Invalid path key: %s'),
+                    $key
+                ));
+            }
+            if (substr($path, 0, 2) === '@ ') {
+                $path = substr($path, 2);
+            }
+            if (\is_dir($path)) {
+                $dirs[$key] = $path;
+            } else {
+                $parent_dir = \dirname($path);
+                if (\is_writable($parent_dir)) {
+                    \ProcessWire\wireMkdir($path);
+                    if (\is_dir($path)) {
+                        $dirs[$key] = $path;
+                    }
+                } else {
+                    throw new WireException(sprintf(
+                        $this->_('Unable to create directory: %s (parent directory not writable)'),
+                        $path
+                    ));
+                }
+            }
+        }
+
+        return $dirs;
+    }
+
+    /**
+     * Get paths for the create directories feature
+     *
+     * @return \stdClass
+     */
+    protected function getDirectoryPaths(): \stdClass {
+
+        // get paths object
+        $paths = $this->paths;
+
+        // append relative URLs
+        $urls = $this->getConfig()['urls'] ?? [];
+        if (!empty($urls)) {
+            foreach ($urls as $key => $url) {
+                if (strpos($url, '/') !== 0) {
+                    // not a local path, skip
+                    continue;
+                }
+                $paths->$key = '@ ' . rtrim($this->wire('config')->paths->root, '/') . $url;
+            }
+        }
+
+        return $paths;
+    }
+
 }

lib/Config.php

@@ -9,7 +9,7 @@
 /**
  * Configuration helper for the Wireframe module
  *
- * @version 0.3.1
+ * @version 0.3.2
  * @author Teppo Koivula <teppo@wireframe-framework.com>
  * @license Mozilla Public License v2.0 https://mozilla.org/MPL/2.0/
  */
@@ -87,7 +87,7 @@ protected function getCreateDirectoriesField(): InputfieldCheckboxes {
     protected function processCreateDirectoriesField(InputfieldCheckboxes $field): InputfieldCheckboxes {
 
         // get an array of paths and bail out early if the paths array is empty
-        $paths = $this->getPaths();
+        $paths = $this->wireframe->getDirectoryPaths();
         if (empty($paths)) {
             $field->notes = $this->_('No directories found, possible configuration error. Please check your site config.');
             return $field;
@@ -123,7 +123,7 @@ protected function processCreateDirectoriesField(InputfieldCheckboxes $field): I
                     if (\is_array($this->wire('input')->post->create_directories) && \in_array($key, $this->wire('input')->post->create_directories)) {
 
                         // attempt to create a directory
-                        $path_created = \ProcessWire\wireMkDir($real_path);
+                        $path_created = \ProcessWire\wireMkdir($real_path);
 
                         if ($path_created) {
 
@@ -162,29 +162,4 @@ protected function processCreateDirectoriesField(InputfieldCheckboxes $field): I
         return $field;
     }
 
-    /**
-     * Get paths for the create directories feature
-     *
-     * @return \stdClass
-     */
-    protected function getPaths(): \stdClass {
-
-        // get paths object from Wireframe
-        $paths = $this->wireframe->paths;
-
-        // append relative URLs
-        $urls = $this->wireframe->getConfig()['urls'] ?? [];
-        if (!empty($urls)) {
-            foreach ($urls as $key => $url) {
-                if (strpos($url, '/') !== 0) {
-                    // not a local path, skip
-                    continue;
-                }
-                $paths->$key = '@ ' . rtrim($this->wire('config')->paths->root, '/') . $url;
-            }
-        }
-
-        return $paths;
-    }
-
 }