Issue #2638290 by Torenware, Mile23, jkopel: Create stream_wrapper_example

Author: torenware

examples.module

@@ -54,6 +54,7 @@ function examples_toolbar() {
     'phpunit_example' => 'phpunit_example_description',
     'plugin_type_example' => 'plugin_type_example.description',
     'simpletest_example' => 'simpletest_example_description',
+    'stream_wrapper_example' => 'stream_wrapper_example.description',
     'queue_example' => 'queue_example',
     'tablesort_example' => 'tablesort_example_description',
     'tour_example' => 'tour_example_description',

file_example/file_example.info.yml

@@ -6,3 +6,4 @@ core: 8.x
 dependencies:
   - examples
   - file
+  - stream_wrapper_example

file_example/src/Form/FileExampleReadWriteForm.php

@@ -140,11 +140,11 @@ protected function getDefaultFile() {
    * @return Drupal\stream_wrapper_example\StreamWrapper\SessionWrapper|bool
    *   Wrapper object to manipulate the SESSION storage or FALSE if the session
    *   wrapper is unavailable.
-   *
-   * @todo Update this to be meaningful when stream_wrapper_example is
-   *   completed. https://www.drupal.org/node/2638290
    */
   protected function getSessionWrapper() {
+    if ($this->sessionSchemeEnabled) {
+      return new \Drupal\stream_wrapper_example\StreamWrapper\SessionWrapper($this->requestStack);
+    }
     return FALSE;
   }
 

file_example/src/Tests/FileExampleTest.php

@@ -54,8 +54,9 @@ public function testFileExampleBasic() {
       'Unmanaged using PHP',
     );
     foreach ($buttons as $button) {
-      // For each scheme supported by Drupal + the session:// wrapper.
-      $schemes = array('public', 'private', 'temporary');
+      // For each scheme supported by Drupal + the session:// wrapper,
+      // which is defined in the stream_wrapper_exampnle.
+      $schemes = array('public', 'private', 'temporary', 'session');
       foreach ($schemes as $scheme) {
         // Create a directory for use.
         $dirname = $scheme . '://' . $this->randomMachineName(10);

stream_wrapper_example/src/Controller/StreamWrapperExampleController.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Drupal\stream_wrapper_example\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+
+/**
+ * Controller class for the Stream Wrapper Example.
+ */
+class StreamWrapperExampleController extends ControllerBase {
+
+  /**
+   * Description page for the example.
+   */
+  public function description() {
+    $build = [
+      'description' => [
+        '#theme' => 'example_description',
+      ],
+    ];
+    return $build;
+  }
+
+}

stream_wrapper_example/src/PathProcessor/PathProcessorSessions.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Drupal\stream_wrapper_example\PathProcessor;
+
+use Drupal\Core\PathProcessor\InboundPathProcessorInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Defines a path processor to rewrite file URLs.
+ *
+ * As the route system does not allow arbitrary amount of parameters convert
+ * the file path to a query parameter on the request. This is similar to what
+ * Core does for the system/files/* URLs.
+ */
+class PathProcessorSessions implements InboundPathProcessorInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function processInbound($path, Request $request) {
+    if (strpos($path, '/examples/stream_wrapper_example/files/') === 0 && !$request->query->has('file')) {
+      $file_path = preg_replace('|^\/examples\/stream_wrapper_example\/files\/|', '', $path);
+      $request->query->set('file', $file_path);
+      // We return the route we want to match.
+      return '/examples/stream_wrapper_example/files';
+    }
+    return $path;
+  }
+
+}