Download the PHP package stackla/stackla-php-sdk without Composer

Stackla PHP SDK

Copyright © 2012 to present. Stackla, Inc., Stackla Pty Ltd., and Stackla Ltd. All rights reserved.

Welcome to the Stackla PHP SDK GitHub repository!

This SDK is intended for PHP developers to enable them to integrate Stackla RESTful APIs into their applications with greater ease. You can find more information on working with Stackla APIs on the Stackla Developer Portal.

We are continuously working on improving both the SDK and the documentation around it, so please feel free to give us feedback and any reports of issues to [email protected].

System requirements

• PHP >= 5.4
• Composer

PHPUnit

Required env variable:

• ACCESS_TOKEN
• API_STACK => Stackla stack short_name
• API_HOST => https://api.stackla.com/api/
• DEFAULT_FILTER_ID
• DEFAULT TAG_ID
• STACKLA_POST_TERM_ID

Great. How do I get this thing going?

Dependencies

Include this package in your composer.json:

And then:

Instantiating a Stack

There are 2 ways to connect to Stackla: OAuth2 or the previous _apikey method The _apikey method is being deprecated over time in favour of the OAuth2 method.

OAuth2 (access_token)

This is the preferred method and is being rolled out to all customers at present.

Generate OAuth2 access token

If you are developing a custom application that will have a client ID, users will need to authenticate and authorise the use their account in order for you to obtain a token. If you are not developing a custom app, may not need to perform this part.

To generate the token, you can generate the OAuth2 callback endpoint for your application as per the following.

link.php

callback.php

More details

API Key (api_key)

This method is being deprecated. Please contact your customer representative if you are using or intend to use this method.

Object Reference

Term

Properties

Methods

Notes

• When creating a new facebook term or twitter user term or instagram user term or pinterest user term or gplus user term or flickr user term, this method will validate the user first.
• After term creation, the and cannot be changed and if it passes, the term will be created. Alternatively, it will return an error when the the user validation has failed.
• These methods are only adding/deleting tag from the properties. You still need to call update.
• Remember to call this method after the term is created. These methods will send a request to RESTful API, there is NO need to call update.

Examples

Create a new instance of term object:

Create a new term:

Get term:

Looping through array of terms:

Update the term:

Add and delete tags:

Delete Term: ```#!php // Create new instance of term object with term id and pull from API $term = $stack->instance('term', 1234);

// Delete term $term->delete();

Catch errors:
```#!php
$term = $stack->instance('term');
try {
    $term->update();
} catch (\Exception $e) {
    echo $e->getMessage();
}

Filter

Properties

Methods

Tile

Properties

Methods

Notes

• create method will only create sta_feed network data.
• update method will only update $status and $tag fields for all network and for sta_feed network the update method will able to update $message, $html, $longitude, $latitude.
• addTag and deleteTag will only add/delete tags from the properties, you still need to call update.

Tag

Properties

Methods

Widget

Properties

Methods

Notes

• clone or duplicate will copy all CSS and JavaScript from the source.
• derive widget cannot be changed. The only fields that can be changed are $filter_id and $name.
• delete will not work if the widget has child widget.

Error Handling