Getting Started: Sessions (#209)

README.md

@@ -7,6 +7,7 @@ Platform. Please follow the tutorials for instructions on using these samples.
 
   * [Getting started with PHP][getting-started]
   * [Authenticating users on PHP][authenticate-users]
+  * [Session handling with PHP][sessions]
 
 ## Contributing changes
 
@@ -20,3 +21,4 @@ Platform. Please follow the tutorials for instructions on using these samples.
 [travis-link]: https://travis-ci.org/GoogleCloudPlatform/getting-started-php
 [getting-started]: http://cloud.google.com/php/getting-started
 [authenticate-users]: http://cloud.google.com/php/getting-started/authenticate-users
+[sessions]: http://cloud.google.com/php/getting-started/sessions

bookshelf/phpunit.xml.dist

@@ -20,11 +20,6 @@
             <directory>test</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-             <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
     <php>
         <env name="PHPUNIT_TESTS" value="1"/>
         <env name="APP_ENV" value="test"/>

bookshelf/test/DeployTest.php

@@ -20,7 +20,6 @@
 use Google\Cloud\TestUtils\FileUtil;
 use Google\Cloud\TestUtils\AppEngineDeploymentTrait;
 use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
-use Google\Cloud\TestUtils\TestTrait;
 use Google\Cloud\Logging\LoggingClient;
 use Google\Cloud\ErrorReporting\V1beta1\ErrorStatsServiceClient;
 use Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange;
@@ -32,7 +31,6 @@
  */
 class DeployTest extends TestCase
 {
-    use TestTrait;
     use AppEngineDeploymentTrait;
     use EventuallyConsistentTestTrait;
 

sessions/.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/.idea

sessions/README.md

@@ -0,0 +1,8 @@
+# Session handling with PHP on Google Cloud Platform
+
+This directory contains the complete sample code for session handling with PHP
+using Firestore. Follow the tutorial to run the code:
+
+  * [Session handling with PHP][sessions]
+
+[sessions]: http://cloud.google.com/php/getting-started/sessions

sessions/app.yaml

@@ -0,0 +1 @@
+runtime: php72

sessions/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-firestore": "^1.9"
+    }
+}

sessions/index.php

@@ -0,0 +1,63 @@
+<?php
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+# [START getting_started_sessions_all]
+require_once __DIR__ . '/vendor/autoload.php';
+
+use Google\Cloud\Firestore\FirestoreClient;
+
+$projectId = getenv('GOOGLE_CLOUD_PROJECT');
+# [START getting_started_sessions_register_handler]
+// Instantiate the Firestore Client for your project ID.
+$firestore = new FirestoreClient([
+    'projectId' => $projectId,
+]);
+
+# [START getting_started_sessions_create_handler]
+$handler = $firestore->sessionHandler(['gcLimit' => 500]);
+# [END getting_started_sessions_create_handler]
+
+// Configure PHP to use the the Firebase session handler.
+session_set_save_handler($handler, true);
+session_save_path('sessions');
+session_start();
+# [END getting_started_sessions_register_handler]
+
+# [START getting_started_sessions_front_controller]
+$colors = ['red', 'blue', 'green', 'yellow', 'pink'];
+/**
+ * This is an example of a front controller for a flat file PHP site. Using a
+ * Static list provides security against URL injection by default.
+ */
+switch (@parse_url($_SERVER['REQUEST_URI'])['path']) {
+    case '/':
+        if (!isset($_SESSION['views'])) {
+            $_SESSION['views'] = 0;
+            $_SESSION['color'] = $colors[rand(0, 4)];
+        }
+        printf(
+            '<body bgcolor="%s">Views: %s</body>',
+            $_SESSION['color'],
+            $_SESSION['views']++
+        );
+        break;
+    default:
+        http_response_code(404);
+        exit('Not Found');
+    }
+# [END getting_started_sessions_front_controller]
+# [END getting_started_sessions_all]

sessions/php.ini

@@ -0,0 +1,3 @@
+; enable the gRPC extension
+extension=grpc.so
+extension=protobuf.so

sessions/phpunit.xml.dist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2019 Google LLC
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<phpunit bootstrap="vendor/autoload.php">
+    <testsuites>
+        <testsuite name="PHP Getting Started Sessions Test Suite">
+            <directory>test</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+             <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

sessions/test/DeployTest.php

@@ -0,0 +1,55 @@
+<?php
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Cloud\GettingStarted\Sessions;
+
+use Google\Cloud\TestUtils\AppEngineDeploymentTrait;
+use PHPUnit\Framework\TestCase;
+use GuzzleHttp\Client;
+
+/**
+ * Class DeployTest
+ */
+class DeployTest extends TestCase
+{
+    use AppEngineDeploymentTrait;
+
+    public function testIndex()
+    {
+        $resp = $this->client->get('/');
+        $this->assertEquals('200', $resp->getStatusCode());
+        $this->assertContains('Views: 0', (string) $resp->getBody());
+
+        $resp = $this->client->get('/');
+        $this->assertEquals('200', $resp->getStatusCode());
+        $this->assertContains('Views: 1', (string) $resp->getBody());
+    }
+
+    /**
+     * Set up the client.
+     *
+     * @before
+     */
+    public function setUpClient()
+    {
+        $url = self::$gcloudWrapper->getBaseUrl();
+        $this->client = new Client([
+            'base_uri' => $url,
+            'cookies' => true,
+        ]);
+    }
+}