[GitHub] rabbah commented on a change in pull request #3816: Reorganize actions doc.

[GitBox <gi...@apache.org>]

rabbah commented on a change in pull request #3816: Reorganize actions doc.
URL: https://github.com/apache/incubator-openwhisk/pull/3816#discussion_r199147868
 
 

 ##########
 File path: docs/actions-php.md
 ##########
 @@ -0,0 +1,120 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+-->
+
+## Creating and invoking PHP actions
+
+The process of creating PHP actions is similar to that of [other actions](actions.md#the-basics).
+The following sections guide you through creating and invoking a single PHP action,
+and demonstrate how to bundle multiple PHP files and third party dependencies.
+
+PHP actions are executed using PHP 7.1.18.
+To use this runtime, specify the `wsk` CLI parameter `--kind php:7.1` when creating or updating an action.
+This is the default when creating an action with file that has a `.php` extension.
+
+An action is simply a top-level PHP function. For example, create a file called `hello.php`
+with the following source code:
+
+```php
+<?php
+function main(array $args) : array
+{
+    $name = $args["name"] ?? "stranger";
+    $greeting = "Hello $name!";
+    echo $greeting;
+    return ["greeting" => $greeting];
+}
+```
+
+PHP actions always consume an associative array and return an associative array.
+The entry method for the action is `main` by default but may be specified explicitly when creating
+the action with the `wsk` CLI using `--main`, as with any other action type.
+
+You can create an OpenWhisk action called `helloPHP` from this function as follows:
+
+```
+wsk action create helloPHP hello.php
+```
+
+The CLI automatically infers the type of the action from the source file extension.
+For `.php` source files, the action runs using a PHP 7.1 runtime.
+
+Action invocation is the same for PHP actions as it is for [any other action](actions.md#the-basics).
+
+```
+wsk action invoke --result helloPHP --param name World
+```
+
+```json
+{
+  "greeting": "Hello World!"
+}
+```
+
+Find out more about parameters in the [Working with parameters](./parameters.md) section.
+
+## Packaging PHP actions in zip files
+
+You can package a PHP action along with other files and dependent packages in a zip file.
+The filename of the source file containing the entry point (e.g., `main`) must be `index.php`.
+For example, to create an action that includes a second file called `helper.php`,
+first create an archive containing your source files:
+
+```bash
+zip -r helloPHP.zip index.php helper.php
+```
+
+and then create the action:
+
+```bash
+wsk action create helloPHP --kind php:7.1 helloPHP.zip
+```
+
+## Including Composer dependencies
+
+If your PHP action requires [Composer](https://getcomposer.org) dependencies,
+you can install them as usual using `composer require` which will create a `vendor` directory.
+Add this directory to your action's zip file and create the action:
+
+```bash
+zip -r helloPHP.zip index.php vendor
+wsk action create helloPHP --kind php:7.1 helloPHP.zip
+```
+
+The PHP runtime will automatically include Composer's autoloader for you, so you can immediately
+use the dependencies in your action code.
+
+Note that if you don't include your own `vendor` folder, then the runtime will include one for you.
+The following PHP extensions are available in addition to the standard ones:
 
 Review comment:
   thanks @akrabat for the review - I think addressed in my last commit if you can kindly look again.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services