https://github.com/digitalocean/sample-functions-php-helloworld
A PHP helloworld sample function for Cloud Functions
https://github.com/digitalocean/sample-functions-php-helloworld
Last synced: about 1 year ago
JSON representation
A PHP helloworld sample function for Cloud Functions
- Host: GitHub
- URL: https://github.com/digitalocean/sample-functions-php-helloworld
- Owner: digitalocean
- Created: 2022-02-14T21:55:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-18T12:20:31.000Z (over 2 years ago)
- Last Synced: 2025-01-15T00:20:04.569Z (over 1 year ago)
- Language: PHP
- Size: 4.88 KB
- Stars: 17
- Watchers: 19
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sample Function: PHP "Hello World"
## Introduction
This repository contains a sample "Hello World" function written in PHP. You can deploy it on DigitalOcean's App Platform as a Serverless Function component or as a standalone Function. Documentation is available at https://docs.digitalocean.com/products/functions.
### Requirements
* You need a DigitalOcean account. If you don't already have one, you can sign up at [https://cloud.digitalocean.com/registrations/new](https://cloud.digitalocean.com/registrations/new).
* To deploy from the command line, you will need the [DigitalOcean `doctl` CLI](https://github.com/digitalocean/doctl/releases).
## Deploying the Function
```
# clone this repo
git clone git@github.com:digitalocean/sample-functions-php-helloworld.git
```
```
# deploy the project, using a remote build so that compiled executable matched runtime environment
doctl serverless deploy sample-functions-php-helloworld --remote-build
```
The output from the deploy command will resemble the following.
```
Deploying 'sample-functions-php-helloworld'
to namespace 'fn-...'
on host '...'
Deployment status recorded in 'sample-functions-php-helloworld/.deployed'
Deployed functions ('doctl sls fn get --url' for URL):
- sample/hello
```
## Using the Function
```
doctl serverless functions invoke sample/hello
```
This will return the default response from the function.
```
{
"body": "Hello stranger!"
}
```
You can pass a parameter to your function using the `-p` command line argument.
```
doctl serverless functions invoke sample/hello -p name:functions
{
"body": "Hello functions!"
}
```
Use this command to retrieve the URL for your function and use it as an API.
```
doctl sls fn get sample/hello --url
```
You can use that API directly in your browser, with `curl` or with an API platform such as Postman.
Parameters may be passed as query parameters, or as JSON body. Here are some examples using `curl`.
```
curl `doctl sls fn get sample/hello --url`?name=query
```
```
curl -H 'Content-Type: application/json' -d '{"name":"body"}' `doctl sls fn get sample/hello --url`
```
### Learn More
You can learn more about Functions by reading the [Functions Documentation](https://docs.digitalocean.com/products/functions).