PHP runtime

Function Compute supports the PHP 7.2 runtime (runtime = php7.2). This topic describes the following features of PHP runtime environment:

• Use logger
• Use built-in extensions
• Use custom extensions
• Use built-in packages
• Use custom packages
• Run external commands
• Handle exceptions

Use logger

When the function uses $GLOBALS['fcLogger'] to output data, the data is collected and stored in the Logstore that you have specified when you create the service. Function Compute provides the logger module, which you can use through the $GLOBALS['fcLogger'] variable.

Log level

You can use the setLevel method to change log levels. The following log levels are listed in descending order of severity.

For more information, see Function Compute logs.

logger example 1

<? php
function handler($event, $context) {
    $logger = $GLOBALS['fcLogger'];
    $logger->info("hello world");
    return 'hello world';
}

The output logs are as follows:

message:2017-07-05T05:13:35.920Z a72df088-f738-cee3-e0fe-323ad89118e5 [INFO] hello world

logger example 2

<?php
use Monolog\Logger;
function handler($evt, $ctx) {
    $logger = $GLOBALS['fcLogger'];
    $logger->setLevel(400);
    $logger->error("console error 1");
    $logger->info("console info 1");
    $logger->warning("console warn 1");
    $logger->debug("console debug 1");
    $logger->setLevel(Logger::WARNING);
    $logger->error("console error 2");
    $logger->info("console info 2");
    $logger->warn("console warn 2");
    $logger->debug("console debug 2");
    $logger->setLevel(200);
}

The output logs are as follows:

2018-08-22T09:01:26Z c19b2706-9c4d-270b-52c8-5248ed5e2315 [ERROR]: console error 1
2018-08-22T09:01:26Z c19b2706-9c4d-270b-52c8-5248ed5e2315 [ERROR]: console error 2
2018-08-22T09:01:26Z c19b2706-9c4d-270b-52c8-5248ed5e2315 [WARNING]: console warn 2

Use built-in extensions

Function Compute provides the following built-in extensions:

"Core", "date", "libxml", "openssl", "pcre", "zlib", "curl","filter", "hash", "readline", "Reflection",
"SPL", "session","xml", "standard", "mysqlnd", "bcmath", "bz2", "calendar","ctype", "dom", "mbstring",
"fileinfo", "ftp", "gettext", "gmp", "iconv","imagick", "json", "exif", "mysqli", "pcntl", "PDO",
"pdo_mysql","Phar", "posix", "protobuf", "redis", "shmop", "SimpleXML", "soap","sockets", "sysvmsg",
"sysvsem", "sysvshm", "tokenizer", "xmlreader","xmlrpc", "xmlwriter"

Example of using a built-in extension

The following example uses imagick to process an image.

<?php
function imageProc($event, $context) {
    $image = new Imagick(__DIR__ . '/lena.jpg');
    $image->thumbnailImage(100, 0);
    $image->writeImages(__DIR__ . "/thumb.jpg", true);
    return strval($image->getImageWidth()) . "," . strval($image->getImageHeight());
}

Use custom extensions

You can add custom extensions by creating a folder named extension in the same directory as the handler files, and adding the .ini and .so files of the extensions to this folder. For example, you can add and use the extension that contains a hello_world function as follows:

.
|____extension
| |____hello.ini
| |____hello.so
|____main.php

• hello.ini

   extension=/code/extension/hello.so

• main.php

    <? php
    function handler($event, $context) {
        var_dump(extension_loaded('hello'));
        hello_world();
        return "ok";
    }

Use built-in packages

Function Compute currently provides the following built-in packages:

Example of using a built-in package

The following example uses a method from the built-in OSS library to upload a TXT file:

<?php
use OSS\OssClient;
function handler($event, $context) {
     $accessKeyId = $context["credentials"]["accessKeyId"];
     $accessKeySecret = $context["credentials"]["accessKeySecret"];
     $securityToken = $context["credentials"]["securityToken"];
     $endpoint = "oss-cn-shenzhen.aliyuncs.com";
     $ossClient = new OssClient($accessKeyId, $accessKeySecret, $endpoint, false, $securityToken);
     $bucket = "my-bucket";
     $object = "php.txt";
     $content = "Hello fc!";
     try {
        $ossClient->putObject($bucket, $object, $content);
     } catch (OssException $e) {
        print($e->getMessage());
     }
    return 'sucess';
}

Use custom packages

Function Compute also allows you to add custom packages. We recommend that you use Composer to install custom packages.

Method 1: Use Composer to install custom packages

If the package you want to use is from Packagist, the PHP Package Repository, you can use Composer to install this package. The following example uses the Function Compute command line tool fcli to install the Humble HTTP request library package requests:

1. Create a folder to store the code and dependency modules.

   mkdir /tmp/code

2. Create a function file, such as /tmp/code/index.php. Use requests in the code.

   <?php
   require_once __DIR__ . "/vendor/autoload.php";
   function handler($event, $context){
      $headers = array('Accept' => 'application/json');
      $options = array('auth' => array('user', 'pass'));
      $request = Requests::get('https://www.baidu.com', $headers, $options);
      var_dump($request->status_code);
      // int(200)
      var_dump($request->headers['content-type']);
      // string(31) "application/json; charset=utf-8"
      var_dump($request->body);
      // string(26891) "[...]"
   }

3. Install the custom package under directory /tmp/code.

   1. Create the composer.json file as follows:

        {
          "require": {
              "rmccue/requests": ">=1.0"
          }
      }

   2. Run the composer install --no-dev command to install the dependencies.

      cd /tmp/code
      composer install --no-dev

   3. Check whether the installation has been successful. The /tmp/code directory is as follows if the installation is successful:

      ls -l /tmp/code
      -rw-r--r--  1 rsong  staff    72  8 22 09:54 composer.json
      -rw-r--r--  1 rsong  staff  2165  8 22 09:54 composer.lock
      -rw-r--r--  1 rsong  staff   523  8 22 09:54 index.php
      drwxr-xr-x  5 rsong  staff   160  8 22 09:54 vendor

4. Use fcli commands to create and call the function.

    ./fcli shell
    cd my-service
    mkf my-func -h index.handler --runtime php7.2 -d /tmp/code
    invk my-func

Method 2: Directly download custom packages

If the package you want to use is not from Packagist, the PHP Package Repository, for example, you want to use Aliyun-openapi-php-sdk and Log Service PHP SDK, you can directly download these packages and use them in the code. The following example uses the Function Compute command line tool fcli to install the Log Service PHP SDK:

1. Create a folder to store the code and dependency modules.

    mkdir /tmp/code

2. Create a function file, such as /tmp/code/index.php. Use Log Service PHP SDK methods in the code.

    <? php
    /* Use the autoloader class to automatically load all required PHP modules. Make sure you specify the correct path of the autoloader file  */
    require_once realpath(dirname(__FILE__) . '/aliyun-log-php-sdk/Log_Autoload.php');
    function handler($event, $context){
        $endpoint = 'cn-hangzhou.sls.aliyuncs.com'; //Select the endpoint that corresponds to the region you have specified when you create the project.
        $accessKeyId = 'your_access_key_id';        //Your Alibaba Cloud AccessKeyId
        $accessKey = 'your_access_key';             //Your Alibaba Cloud AccessKeySecret
        $project = 'your_project';                  //The log project name
        $logstore = 'your_logstore';                //The LogStore name
        $client = new Aliyun_Log_Client($endpoint, $accessKeyId, $accessKey);
        # List all LogStores in the specified log project
        $req1 = new Aliyun_Log_Models_ListLogstoresRequest($project);
        $res1 = $client->listLogstores($req1);
        var_dump($res1);
    }

3. Download dependencies to directory /tmp/code.

   1. Run the following commands to download the dependencies.

      cd /tmp/code
      git clone https://github.com/aliyun/aliyun-log-php-sdk.git

   2. Check whether the download has been successful. The /tmp/code directory is as follows if the download is successful:

        ls -l /tmp/code
        drwxr-xr-x  11 rsong  staff  352  8 22 10:35 aliyun-log-php-sdk
        -rw-r--r--   1 rsong  staff  957  8 22 10:42 index.php

4. Use fcli commands to create and call the function.

    ./fcli shell
    cd my-service
    mkf my-func -h index.handler --runtime php7.2 -d /tmp/code
    invk my-func

Run external commands

If you want to run external tools, such as shell scripts, C++ code, or Go executables in your PHP functions, you can package and upload the tools and code together, and run external commands to use these tools. You can use the following PHP methods to run external programs: exec, system, and shell-exec.

Note: To run C, C++, and Go executables, make sure that the files are compatible with the Function Compute runtime environment. The PHP runtime environment in Function Compute is based on Linux 4.4.24-2.al7.x86_64 and Docker pull php:7.2.

The following example demonstrates how to use the exec method to run a shell script:

<? php
function handler($evt, $ctx){
    $script = $_ENV['FC_FUNC_CODE_PATH'] . '/script.sh';
    $a = exec("bash " . $script, $out, $status);
    print_r($a);
    var_dump($out);
    print_r($status);
}

Handle exceptions

Function Compute captures exceptions that occur when executing PHP functions and returns information about the exceptions. The following example returns the oops exception:

<? php
function handler(event, context) {
  throw new Exception("oops");
}

The system outputs the following response when the preceding function is called:

{
    "errorMessage":"oops",
    "errorType":"Exception",
    "stackTrace":{
        "file":"/code/index.php",
        "line":3,
        "traceString":"#0 /var/fc/runtime/php7/src/invoke.php(67): handler('{\n "product"...', Array)
#1 "
    }
}

When an exception occurs, the HTTP header in the response message of the call containsX-Fc-Error-Type: UnhandledInvocationError. For more information about errors in Function Compute, see Error message.