Download the PHP package lasselehtinen/elvis without Composer

Installation

Laravel 5.X

Step 1

Add the package to your composer.json and run composer update.

{
    "require": {
        "lasselehtinen/elvis": "3.0.0"
    }
}

Step 2

Add the service provider and alias in config/app.php:

'providers' => array(
    ...
    Lasselehtinen\Elvis\ElvisServiceProvider::class
),

Step 3

Publish the package config file by running:

php artisan vendor:publish

This copies the Elvis config to config/Elvis.php and references to the .env configuration file used by Laravel 5. So edit the .env file and add the following entries:

ELVIS_API_ENDPOINT_URI='http://elvis.domain.com/services/',
ELVIS_USERNAME='elvis_username',
ELVIS_PASSWORD='elvis_password'

Laravel 4.X

Step 1

Add the package to your composer.json and run composer update.

{
    "require": {
        "lasselehtinen/elvis": "1.0.1"
    }
}

Step 2

Add the service provider and alias in app/config/app.php:

'providers' => array(
    ...
    'Lasselehtinen\Elvis\ElvisServiceProvider'
),

And

'aliases' => array(
    ...
    'Elvis'           => 'Lasselehtinen\Elvis\Facades\Elvis'
),

Step 3

Publish the package config file by running:

php artisan config:publish lasselehtinen/elvis

Edit your app/config/packages/lasselehtinen/elvis/config.php and change the default Elvis REST API endpoint URI and the username and password.

Usage

List of supported functions

• Login
• Browse
• Search
• Profile
• Create
• Update
• Updatebulk
• Move / rename
• Copy
• Remove
• Create folder
• Create relation
• Remove relation
• Log usage stats
• Messages / Localization
• Checkout
• Undocheckout
• CreateAuthKey
• UpdateAuthKey
• RevokeAuthKeys
• Logout

Login

You need to login as the first step. Store the CSRF token returned by the function and pass it to further requests.

$token = Elvis::login();
$search_results = Elvis::search($token, 'gtin:9789510123454');

Browse

This call is designed to allow you to browse folders and show their subfolders and collections, similar to how folder browsing works in the Elvis desktop client. Read more at https://helpcenter.woodwing.com/hc/en-us/sections/200449479-API.

Note: Even though it is possible to return the assets in folders, doing so is not advised. The browse call does not limit the number of results, so if there are 10000 assets in a folder it will return all of them. It is better to use a search to find the assets in a folder and fetch them in pages.

$browse_results = Elvis::browse($token, '/Folder/');

Search

Wrapper for the search API, returns the hits found. You can find more information at https://helpcenter.woodwing.com/hc/en-us/articles/202967175-REST-search. You can find details about the function parameters below.

Simple search:

$search_results = Elvis::search($token, 'gtin:9789510123454');

Profile

Retrieve details about the authenticated user.

$profile = Elvis::profile($token);

Create

This call will create a new asset in Elvis. It can be used to upload files into Elvis. It can also be used to create 'virtual' assets like collections. In that case no file has to be uploaded and Elvis will create a 0 kb placeholder for the virtual asset. Read more at https://helpcenter.woodwing.com/hc/en-us/articles/202967215-REST-create.

Note: Either assetPath, filename or name as to be specified in the metadata.

$create = Elvis::create($token, './file.txt', array('assetPath' => '/Users/demouser/filename.txt'));

Update

This call updates an existing asset in Elvis with a new file. It can also be used to update metadata. Works pretty much the same ways a create. Only difference is that you given additional parameter, the asset id. Read more at https://helpcenter.woodwing.com/hc/en-us/articles/202250049-REST-update.

$update = Elvis::update($token, '1_OSDdstqxbACb97Vd-ret', null, array('Description' => 'Nice view'));

Updatebulk

This call updates the metadata of multiple existing assets in Elvis.

Available since Elvis 3.1

$updatebulk = Elvis::updatebulk($token, 'tags:animal', array('status' => 'Correction'));

Returns either processedCount or processId depending on the value of async.

Move / rename

Move or rename a folder or a single asset. You can combine a rename operation and a move operation. Just specify the new target path.

When you move or rename a folder, all assets contained in the folder will also be moved to the new location. The subfolder structure will be kept intact.

$rename = Elvis::move($token, '/Path/to/asset/filename.ext', '/Path/to/asset/new-filename.ext');

Please see https://helpcenter.woodwing.com/hc/en-us/articles/202967265-REST-move-rename for more information about the folderReplacePolicy and fileReplacePolicy.

Copy

Copy a folder or a single asset.

When you copy a folder, all subfolders and assets contained in it will also be copied to the new location. The subfolder structure will be kept intact unless you set flattenFolder to true.

$copy = Elvis::copy($token, '/Path/to/asset/filename.ext', '/Path/to/asset/copy-filename.ext');

Please see https://helpcenter.woodwing.com/hc/en-us/articles/202967305-REST-copy for more information about the folderReplacePolicy and fileReplacePolicy.

Returns either processedCount or processId depending on the value of async.

Remove

Remove one or more assets. This will remove only assets, no folders.

$ids = array('1_OSDdstqxbACb97Vd-ret', '1wefOS6bauK8uRxi0rn9EK');
$remove = Elvis::remove($token, null, $ids, null, false);

Either 'q' or 'ids' or 'folderPath' must be specified.

Returns either processedCount or processId depending on the value of async.

Create folder

Remove one or more assets. This will remove only assets, no folders.

$createFolder = Elvis::createFolder($token, '/Users/lasleh/New');

Returns an object with the olderPaths of each folder as key with the corresponding result as value (always a string). The following results are possible:

• "created"
• "already exists"
• "access denied"
• an error message indicating why the folder could not be created

• Create relation

  Remove one or more assets. This will remove only assets, no folders.

  $createRelation = Elvis::createRelation($token, 'contains', 'FWiH0ipWKVl8CkbFGm9me9', 'CFN7pN2S4GFBz4Vorc34VJ');

The operation returns an empty 200 OK status. If the operation fails, an error page with a 500 error status will be returned.

Remove relation

Remove one or more relations between assets.

$removeRelation = Elvis::removeRelation($token, ['77-nZwDXaTJ96lhhaDvp0t']);

The operation returns an empty 200 OK status.

If the operation fails, an error page with a 500 error status will be returned.

Log usage stats

Logs an entry in the stats database for usage statistics about assets. A record will be added to the "usage_log" table, see Query stats for details.

$logUsage = Elvis::logUsage($token, 'FWiH0ipWKVl8CkbFGm9me9', 'CUSTOM_ACTION_test', array('metadataKey'=>'value'));

This call does not return a value, it only returns an http 200 status OK.

Messages / Localization

Retrieve message bundles from the Elvis server.

Allows localization of a custom plugin using messages available on the server. The messages from the webclient web or desktop client acm can be used in your own plugin. It is also possible to use any custom messages defined in the Config/messages folder.

The common message bundle cmn is always returned and merged with the requested bundle. The common bundle contains messages for relations, metadata fields, metadata groups and metadata values. The common message keys have the following structure:

Relations:

relation.[relation type].label

Metadata fields:

field_label.[field name]

Metadata groups:

field_group_label.[group name]

Metadata values:

field_value_label.[field name].[value]    

For a full list of available messages see this knowledge base article.

 $messages = Elvis::messages($token, 'fi_FI');

The service returns an object containing all keys and messages. Please note that commas in object properties have to be referenced like this:

$messages->{'field_label.creatorEmail'}

Checkout

Checks out an asset from the system locking the file for other users.

$checkout= Elvis::checkout($token, $assetId);

This will return the checkout metadata in the response as an object.

Undocheckout

Undo a checkout for a single asset

$checkout = Elvis::undocheckout($token, $assetId);

CreateAuthKey

Create an authKey in Elvis.

$createAuthKey = Elvis::createAuthKey($token, 'Test', '2999-01-01', array($assetId));

Returns object containing the authKey and links to different clients.

UpdateAuthKey

Update an authKey in Elvis.

With this API call it is possible to update certain properties of an authKey. Please note that it is not possible to add or remove assets from an authKey once it has been created.

$updateAuthKey = Elvis::updateAuthKey($token, $authKey, 'Test', '2999-02-02');

Returns object containing the authKey and links to different clients.

RevokeAuthKeys

Create an authKey in Elvis.

$revokeAuthKeys = Elvis::revokeAuthKeys($token, array($assetId));

Returns an empty object if succesfull.

Logout

It is a good practice to close the session after you are done with your queries so it doesn't take API licences unnecessarily. You can use logout for this.

$logout = Elvis::logout($token);