Quickstart for PHP in the App Engine Flexible Environment

This quickstart shows you how to create a small App Engine application that displays a short message.

Before you begin

Before running and deploying this sample, take the following steps:

  1. Use the Cloud Platform Console to create a new Cloud Platform project, create an App Engine application, and enable billing:
    Go to App Engine

    When prompted, select the region where you want your App Engine application located and then enable billing.

  2. Install the following prerequisites locally:
    1. Download and install git.
    2. Download and install the Google Cloud SDK and then initialize the gcloud tool:
      Download the SDK
    3. Install PHP 5.6, 7.0, or 7.1.
    4. To manage dependencies, download Composer and make sure the Composer executable is installed globally.
  3. Alternatively: You can use Google Cloud Shell, which comes with git and Cloud SDK already installed, and many other features, such as language support and code editors.

    After Google Cloud Shell is launched, you can proceed with the rest of this tutorial and execute your commands within Cloud Shell.

App Engine locations

App Engine is regional, which means the infrastructure that runs your apps is located in a specific region and is managed by Google to be redundantly available across all the zones within that region.

Meeting your latency, availability, or durability requirements are primary factors for selecting the region where your apps are run. You can generally select the region nearest to your app's users but you should consider the location of the other Cloud Platform products and services that are used by your app. Using services across multiple locations can affect your app's latency as well as pricing.

App Engine is available in the following regions:

  • us-central1
  • us-east1
  • us-east4
  • southamerica-east1 *
  • europe-west1
  • europe-west2
  • europe-west3
  • asia-northeast1
  • australia-southeast1

* For customers using the São Paulo region, all regional product SLAs will remain in force. However, multi-region and cross-region functionality spanning North America and South America may temporarily have reduced availability or performance.

You cannot change an app's region after you set it.

This quickstart assumes that you are familiar with the PHP programming language.

Download the Hello World app

We've created a simple Hello World app for PHP so you can quickly get a feel for deploying an app to the App Engine flexible environment. Follow these steps from a command line to download Hello World to your local machine.

Download the sample app and navigate into the app directory:

  1. Clone the Hello World sample app repository to your local machine:

    git clone https://github.com/GoogleCloudPlatform/getting-started-php.git
    

    Alternatively, you can download the sample as a zip file and extract it.

  2. Change to the directory that contains the sample code:

    cd getting-started-php/1-hello-world
    

Run Hello World on your local machine

To run the Hello World app on your local computer:

  1. Install dependencies:

    composer install
    
  2. Start a local web server:

    php -S localhost:8080 -t web/
    
  3. In your web browser, enter the following address:

    http://localhost:8080
    

    You can see the Hello World message from the sample app displayed in the page.

    In your terminal window, press Ctrl+C to exit the web server.

    Deploy and run Hello World on App Engine

    To deploy your app to the App Engine flexible environment:

    1. Deploy the Hello World app by running the following command from the 1-hello-world directory:
      gcloud app deploy
      Learn about the optional flags.

      Common gcloud command flags

      • Include the --version flag to specify an ID that uniquely identifies that version of your app, otherwise one is generated for you. Example: --version [YOUR_VERSION_ID]
      • Include the --project flag to specify an alternate Cloud Platform project ID to what you initialized as the default in the gcloud tool. Example: --project [YOUR_PROJECT_ID]

      Example:

      gcloud app deploy --version pre-prod-5 --project my-sample-app

      To learn more about deploying your app from the command line, see Testing and Deploying Your App . For a list of all the command flags, see the gcloud app deploy reference.

    2. Launch your browser and view the app at http://YOUR_PROJECT_ID.appspot.com, by running the following command:
      gcloud app browse
    This time, the page that displays the Hello World message is delivered by a web server running on an App Engine instance.

    Congratulations! You've deployed your first PHP app to App Engine flexible environment!

    See the following sections for information about cleaning up as well as links to the possible next steps that you can take.

Clean up

To avoid incurring charges, you can delete your Cloud Platform project to stop billing for all the resources used within that project.

  1. In the Cloud Platform Console, go to the Projects page.

    Go to the Projects page

  2. In the project list, select the project you want to delete and click Delete project. After selecting the checkbox next to the project name, click
      Delete project
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

What's next

Learn the whole platform

Now that you know what it's like to develop and deploy App Engine apps, you can stretch out and see the rest of Google Cloud Platform. You already have the Google Cloud SDK installed and that gives you the tools to interact with products like Google Cloud SQL, Google Cloud Storage, Google Cloud Datastore, and more. For a guided walkthrough that teaches you how to create an application that uses the entire platform, not just App Engine, check out our quickstart on creating the Bookshelf app.

Learn about the App Engine flexible environment

Here are some topics to help continue your learning about App Engine.

Hello World code review

Hello World is the simplest possible App Engine app, as it contains only one service, has only one version, and all of the code is located within the app's root directory. This section describes each of the app files in detail.

index.php

The index.php file contains the PHP code to start a server and respond to requests. This example uses Silex, but you can use other PHP web frameworks.

This code creates a new Silex Application object and then defines two GET routes:

require_once __DIR__ . '/../vendor/autoload.php';

$app = new Silex\Application();

$app->get('/', function () {
    return 'Hello World';
});

$app->get('/goodbye', function () {
    return 'Goodbye World';
});

// @codeCoverageIgnoreStart
if (PHP_SAPI != 'cli') {
    $app->run();
}
// @codeCoverageIgnoreEnd

return $app;

app.yaml

The app.yaml file describes an application's deployment configuration:

runtime: php
env: flex

runtime_config:
  document_root: web

Here, app.yaml specifies the runtime used by the app, and sets env: flex, specifying that the app uses the flexible environment.

composer.json

composer.json is used to declare, install, and update application dependencies:

{
  "autoload": {
    "psr-4": {
      "Google\\Cloud\\Samples\\Bookshelf\\": ["src", "test/lib"]
    }
  },
  "require": {
    "php": "5.6.*|7.0.*|7.1.*",
    "silex/silex": "^1.3"
  },
  "require-dev": {
    "behat/mink": "^1.7",
    "behat/mink-goutte-driver": "^1.2",
    "phpunit/phpunit": "~4",
    "symfony/browser-kit": "^3.0",
    "symfony/http-kernel": "^3.0",
    "google/cloud-tools": "^0.6"
  }
}

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

App Engine flexible environment for PHP docs