Update PicoFilePrefixes to Pico 2.0+

Author: PhrozenByte

PicoFilePrefixes.php

@@ -1,4 +1,14 @@
 <?php
+/**
+ * This file is part of Pico. It's copyrighted by the contributors recorded
+ * in the version control history of the file, available from the following
+ * original location:
+ *
+ * <https://github.com/PhrozenByte/pico-file-prefixes/blob/master/PicoFilePrefixes.php>
+ *
+ * SPDX-License-Identifier: MIT
+ * License-Filename: LICENSE
+ */
 
 /**
  * Pico file prefixes plugin - drop file prefixes from page URLs
@@ -15,22 +25,31 @@
  */
 class PicoFilePrefixes extends AbstractPicoPlugin
 {
+    /**
+     * API version used by this plugin
+     *
+     * @var int
+     */
+    const API_VERSION = 2;
+
     /**
      * Regex pattern matching directory paths with prefixed files
+     *
      * @var string
      */
     protected $filePathRegex = '';
 
     /**
      * List of pages whose URL has been altered
+     *
      * @var array
      */
     protected $prefixPages = array();
 
     /**
-     * Prepare the plugin's configuration and prepare the file path regex
+     * Prepares the plugin's configuration and the file path regex
      *
-     * @see    DummyPlugin::onRequestFile()
+     * @see DummyPlugin::onConfigLoaded()
      */
     public function onConfigLoaded(array &$config)
     {
@@ -54,11 +73,11 @@ public function onConfigLoaded(array &$config)
         }
 
         // prepare file path regex
-        $this->filePathRegex = '#^(';
+        $this->filePathRegex = '#^';
         if (!empty($config['PicoFilePrefixes']['recursiveDirs'])) {
             if (in_array('.', $config['PicoFilePrefixes']['recursiveDirs'])) {
                 // enable plugin for any directory
-                $this->filePathRegex = '#^(.+)$#';
+                $this->filePathRegex = '#^.+$#';
                 return;
             }
 
@@ -75,13 +94,13 @@ public function onConfigLoaded(array &$config)
                 return preg_quote($dir, '#');
             }, $config['PicoFilePrefixes']['dirs']));
         }
-        $this->filePathRegex .= ')$#';
+        $this->filePathRegex .= '$#';
     }
 
     /**
-     * Rewrite shortened URLs to their matching file on the filesystem
+     * Rewrites shortened URLs to their matching file on the filesystem
      *
-     * @see    DummyPlugin::onRequestFile()
+     * @see DummyPlugin::onRequestFile()
      */
     public function onRequestFile(&$file)
     {
@@ -107,16 +126,12 @@ public function onRequestFile(&$file)
     }
 
     /**
-     * Alter URLs of prefixed files
+     * Alters URLs of prefixed files
      *
-     * @see    DummyPlugin::onPagesLoaded()
+     * @see DummyPlugin::onPagesLoaded()
      */
-    public function onPagesLoaded(
-        array &$pages,
-        array &$currentPage = null,
-        array &$previousPage = null,
-        array &$nextPage = null
-    ) {
+    public function onPagesLoaded(array &$pages)
+    {
         foreach ($pages as &$pageData) {
             $filePath = dirname($pageData['id']);
             if (preg_match($this->filePathRegex, $filePath)) {

README.md

@@ -10,28 +10,50 @@ Pico is a stupidly simple, blazing fast, flat file CMS. See http://picocms.org/
 Install
 -------
 
-Just [download the latest release](https://github.com/PhrozenByte/pico-file-prefixes/releases/latest) and upload the `PicoFilePrefixes.php` file to the `plugins` directory of your Pico installation (e.g. `/var/www/html/pico/plugins/`). The plugin is also available on [Packagist.org](https://packagist.org/packages/phrozenbyte/pico-file-prefixes) and may be included in other projects via `composer require phrozenbyte/pico-file-prefixes`. The plugin requires Pico 1.0+
+You can either install `PicoFilePrefixes` using [Composer](https://getcomposer.org/), or using a single PHP plugin file. We recommend you to use Composer whenever possible, because it allows you to keep the plugin up-to-date way more easily.
+
+If you use a Composer-based installation of Pico and want to either remove or install `PicoFilePrefixes`, simply open a shell on your server and navigate to Pico's install directory (e.g. `/var/www/html/pico/`). Run `composer remove phrozenbyte/pico-file-prefixes` to remove `PicoFilePrefixes`, or run `composer require phrozenbyte/pico-file-prefixes` (via [Packagist.org](https://packagist.org/packages/phrozenbyte/pico-file-prefixes)) to install `PicoFilePrefixes`.
+
+If you really want to install `PicoFilePrefixes` using a single PHP plugin file, [download the latest release](https://github.com/PhrozenByte/pico-file-prefixes/releases/latest) and upload the `PicoFilePrefixes.php` file to the `plugins` directory of your Pico installation (e.g. `/var/www/html/pico/plugins/`).
+
+`PicoFilePrefixes` requires Pico 2.0+
 
 Config
 ------
 
-The plugin recursively drops file prefixes of all files in the `content/blog/` directory by default. You can specify other directories by altering the `$config['PicoFilePrefixes']['recursiveDirs']` and/or `$config['PicoFilePrefixes']['dirs']` config variables in your `config/config.php`. The former parses all files of a directory recursively (i.e. including all its subfolders), whereas the latter parses just files in this particular directory. The default configuration looks like the following:
+The plugin recursively drops file prefixes of all files in the `content/blog/` directory by default. You can specify other directories by altering the `PicoFilePrefixes.recursiveDirs` and/or `PicoFilePrefixes.dirs` config variables (both expect YAML lists) in your `config/config.php`. The former parses all files of a directory recursively (i.e. including all its subfolders), whereas the latter parses just files in this particular directory. The default configuration looks like the following:
 
-```php
-$config['PicoFilePrefixes']['recursiveDirs'] = array('blog');
-$config['PicoFilePrefixes']['dirs'] = array();
+```yaml
+PicoFilePrefixes:
+  recursiveDirs:
+    - blog
+  dirs: []
 ```
 
 If you want to additionally enable the plugin for the `content/showcase/` directory, try the following configuration:
 
-```php
-$config['PicoFilePrefixes']['recursiveDirs'] = array('blog', 'showcase');
-$config['PicoFilePrefixes']['dirs'] = array();
+```yaml
+PicoFilePrefixes:
+  recursiveDirs:
+    - blog
+    - showcase
+  dirs: []
 ```
 
 If you want to enable the plugin for any folder, try the following:
 
-```php
-$config['PicoFilePrefixes']['recursiveDirs'] = array('.');
-$config['PicoFilePrefixes']['dirs'] = array();
+```yaml
+PicoFilePrefixes:
+  recursiveDirs:
+    - .
+  dirs: []
+```
+
+To enable the plugin for pages in the `content/misc/` directory only (i.e. not including subfolders like `content/misc/sub/`), try the following:
+
+```yaml
+PicoFilePrefixes:
+  recursiveDirs: []
+  dirs:
+    - misc
 ```