toc

• PHP SDK
  • Installation
  • Initialization
  • Reference
    • \$evervault->encrypt()
    • \$evervault->run()

PHP SDK

A full reference of our PHP SDK.

The Evervault PHP SDK is a toolkit for encrypting data as it enters your server.

Installation

Install the Evervault PHP SDK.

bash
composer require evervault/evervault-php

php
require_once('vendor/autoload.php');

Initialization

php
use \Evervault\Evervault;
// Insert your API key here
$evervault = new Evervault('<YOUR_API_KEY>');
// Encrypt your sensitive data
$encrypted = $evervault->encrypt([
    'name' => 'Alice'
]);
// Process the encrypted data in a Cage
$result = $evervault->run('hello-cage', $encrypted);

Reference

The Evervault PHP SDK exposes two functions:

• $evervault->encrypt()
• $evervault->run()

\$evervault->encrypt()

$evervault->encrypt() encrypts data for use in your Cages. To encrypt data on your server, simply pass an array or string into the $evervault->encrypt() function. Store the encrypted data in your database as normal.

php
$evervault->encrypt($data = array | string)

\$evervault->run()

$evervault->run() lets you invoke a Cage with a given payload.

php
$evervault->run($cageName = string, $data = array[, $options = $array])