diff --git a/docs/develop/php/index.mdx b/docs/develop/php/index.mdx index c27328cb1f..cdb04d6b44 100644 --- a/docs/develop/php/index.mdx +++ b/docs/develop/php/index.mdx @@ -20,6 +20,7 @@ Build Temporal Applications with the PHP SDK. **Temporal PHP Technical Resources:** +- [PHP SDK Quickstart - Setup Guide](https://docs.temporal.io/develop/php/set-up-your-local-php) - [PHP API Documentation](https://php.temporal.io) - [PHP SDK Code Samples](https://github.com/temporalio/samples-php) - [PHP SDK GitHub](https://github.com/temporalio/sdk-php) diff --git a/docs/develop/php/set-up.mdx b/docs/develop/php/set-up.mdx new file mode 100644 index 0000000000..e7cf29ccf1 --- /dev/null +++ b/docs/develop/php/set-up.mdx @@ -0,0 +1,422 @@ +--- +id: set-up-your-local-php +title: Set up your local with the PHP SDK +sidebar_label: Quickstart - Setup +description: Configure your local development environment to get started developing with Temporal +keywords: + - set up + - getting started + - PHP sdk +tags: + - PHP guide + - setup + - getting started +hide_table_of_contents: true +--- + +import { SetupSteps, SetupStep, CodeSnippet } from "@site/src/components/elements/SetupSteps"; +import { CallToAction } from "@site/src/components/elements/CallToAction"; + +# Quickstart - Setup + +Configure your local development environment to get started developing with Temporal. + + + + + mkdir helloworld-temporalphp && cd helloworld-temporalphp + + +}> +## Create your project directory + +First, create and navigate into your project directory: + + + + + +composer require temporal/sdk + + +}> + +## Install the Temporal PHP SDK + +Install the PHP SDK using Composer: + +If you don't already have Composer installed, you can install it using Homebrew on macOS: +Or, [follow these instructions](https://getcomposer.org/download/) on the Composer website for Linux or Windows. + + + + + +sudo pecl install grpc + + +

Then verify the extension is loaded:

+ +php -m | grep grpc + + +}> + +## Install the gRPC extension + +The Temporal PHP SDK requires the gRPC extension for client operations. +Install it using PECL: + +**Note:** After installation, you may need to restart your terminal or web server. +Use `php --ini` to find your php.ini location if needed. + + + + + +

The Temporal PHP SDK includes RoadRunner for running workers. +You'll create a configuration file for it.

+ + +touch .rr.yaml + +}> + +## Create RoadRunner Configuration + + +Create a `.rr.yaml` file in your project directory - you'll configure it in the next step. + + + + + + + +

Install the Temporal CLI using Homebrew:

+ + brew install temporal + + + + +

Download the Temporal CLI archive for your architecture:

+ +

Extract it and add temporal.exe to your PATH.

+ + + +

Download the Temporal CLI for your architecture:

+ +

Extract the archive and move the temporal binary into your PATH, for example:

+ + sudo mv temporal /usr/local/bin + + + + + +}> + +## Install Temporal CLI and start the development server + +The fastest way to get a development version of the Temporal Service running on your local machine is to use [Temporal CLI](https://docs.temporal.io/cli). + +Choose your operating system to install Temporal CLI: + + + + +{`version: "3" + +rpc: + listen: tcp://127.0.0.1:6001 + +server: + command: "php -d display_errors=stderr src/worker.php" + +temporal: + address: \${TEMPORAL_HOST:-localhost}:\${TEMPORAL_PORT:-7233} + activities: + num_workers: 4 + +logs: + level: info + mode: development`} + + +}> + +## Create a RoadRunner configuration file + +To configure RoadRunner Temporal plugin create or open the `.rr.yaml` file in your project directory and make sure it contains the following: + +Replace the default contents of your `.rr.yaml` file with the following configuration, which is required to run the Temporal Worker: +This example shows a minimal .rr.yaml configuration specifically for running a Temporal Worker. + + + + + +

After installing, open a new Terminal window and start the development server:

+ +temporal server start-dev + + +
+

Change the Web UI port

+

The Temporal Web UI may be on a different port in some examples or tutorials. To change the port for the Web UI, use the --ui-port option when starting the server:

+ +temporal server start-dev --ui-port 8080 + +

The Temporal Web UI will now be available at http://localhost:8080.

+
+ + +}> + +## Start the development server + +Once you've installed Temporal CLI and added it to your PATH, open a new Terminal window and run the following command. + +This command starts a local Temporal Service. It starts the Web UI, creates the default Namespace, and uses an in-memory database. + +The Temporal Service will be available on localhost:7233. +The Temporal Web UI will be available at http://localhost:8233. + +Leave the local Temporal Service running as you work through tutorials and other projects. You can stop the Temporal Service at any time by pressing CTRL+C. + +Once you have everything installed, you're ready to build apps with Temporal on your local machine. + + + + +## Run Hello World: Test Your Installation + +Now let's verify your setup is working by creating and running a complete Temporal application with both a Workflow and Activity. + +This test will confirm that: + +- Your PHP SDK installation is working +- Your local Temporal Service is running +- You can successfully create and execute Workflows and Activities +- The communication between components is functioning correctly + +### 0. Configure Composer Autoloading + +First, configure Composer to autoload your classes. +Add the following to your `composer.json` file above the "require" section: + +```json +{ + "autoload": { + "psr-4": { + "App\\": "src/" + } + }, + "require": { + "temporal/sdk": "^2.0" + } +} +``` + +Then run: + +```bash +composer dump-autoload -o --classmap-authoritative +``` + +### 1. Create the Activity Interface + +Create an Activity Interface file (GreetingActivityInterface.php) in an Activities subdirectory: + +```php +withScheduleToCloseTimeout(CarbonInterval::seconds(10)) + ); + + return yield $activity->greet($name); + } +} +``` + +### 5. Create and Run the Worker + +With your Activity and Workflow defined, you need a Worker to execute them. A Worker polls a Task Queue, that you configure it to poll, looking for work to do. Once the Worker dequeues the a Workflow or Activity task from the Task Queue, it then executes that task. + +Workers are a crucial part of your Temporal application as they're what actually execute the tasks defined in your Workflows and Activities. +For more information on Workers, see [Understanding Temporal](/evaluate/understanding-temporal#workers) and a [deep dive into Workers](/workers). + +Create a Worker file (worker.php): + +```php +newWorker(); + +$worker->registerWorkflowTypes(\App\Workflows\SayHelloWorkflow::class); +$worker->registerActivityImplementations(new \App\Activities\GreetingActivity()); + +$factory->run(); +``` + +Run the Worker: + +```bash +php worker.php +``` + +### 6. Execute the Workflow + +Now that your Worker is running, it's time to start a Workflow Execution. + +Create a separate file called starter.php: + +```php +newWorkflowStub( + \App\Workflows\SayHelloWorkflowInterface::class, + WorkflowOptions::new() + ->withWorkflowId('say-hello-workflow-id') + ->withTaskQueue('my-task-queue') +); + +$result = $workflow->sayHello('Temporal'); +echo "Workflow result: " . $result . PHP_EOL; +``` + +Then run: + +```bash +php starter.php +``` + +### Verify Success + +If everything is working correctly, you should see: + +- Worker processing the Workflow and Activity +- Output: `Workflow result: Hello Temporal` +- Workflow Execution details in the [Temporal Web UI](http://localhost:8233) + + +

Next: Run your first Temporal Application

+

Learn how to create a basic Workflow and run it with the Temporal PHP SDK

+ diff --git a/docs/quickstarts.mdx b/docs/quickstarts.mdx index 5f4860a0ab..53561dde20 100644 --- a/docs/quickstarts.mdx +++ b/docs/quickstarts.mdx @@ -21,6 +21,7 @@ Choose your language to get started quickly. { href: "/develop/python/set-up-your-local-python", title: "Python", description: "Install the Python SDK and run a Hello World Workflow in Python." }, { href: "/develop/typescript/set-up-your-local-typescript", title: "TypeScript", description: "Install the TypeScript SDK and run a Hello World Workflow in TypeScript." }, { href: "/develop/dotnet/set-up-your-local-dotnet", title: ".NET", description: "Install the .NET SDK and run a Hello World Workflow in C#." }, + { href: "/develop/php/set-up-your-local-php", title: "PHP", description: "Install the PHP SDK and run a Hello World Workflow in PHP." }, ]} /> diff --git a/sidebars.js b/sidebars.js index c6b0edcd82..ecd98a94b9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -167,6 +167,7 @@ module.exports = { id: "develop/php/index", }, items: [ + "develop/php/set-up-your-local-php", "develop/php/core-application", "develop/php/temporal-client", "develop/php/testing-suite",