Wallogit.com
2017 © Pedro Peláez
Yii2 component for integration with asana via REST API
Yii2 Asana is a component for Yii2 framework designed for integration with Asana CMS via XML-RPC API., (*1)
This component is built on top of Asana XML-RPC PHP Client by Hieu Le Trung., (*2)
, (*3)
Note: This extension mandatorily requires Yii Framework 2. The framework is under active development and the first stable release of Yii 2 is expected in early 2014., (*4)
The preferred way to install this extension is through Composer., (*5)
Either run, (*6)
php composer.phar require marshmeloo/yii2-Asana "dev-master", (*7)
or add, (*8)
"marshmeloo/yii2-Asana": "dev-master", (*9)
to the require section of your composer.json file., (*10)
In order to use this extension, first thing you need to do is to create a blog (you can change the name if you want)
component and configure it. Here is the example of minimal configuration (in your config/main.php):, (*11)
'components' => [
...
'blog' => [
'class' => '\marshmeloo\yii2wp\Asana',
'endpoint' => 'http://example.com/xmlrpc.php',
'username' => 'demo',
'password' => 'demo'
]
...
]
When component is configured, you can start making requests to your Asana site., (*12)
For example, get ten latest published posts. Select guid, post_title and post_content fields only:, (*13)
$blogPosts = Yii::$app->blog->getPosts([
'post_status' => 'publish',
'number' => 10
], ['guid', 'post_title', 'post_content']);
Or create a new post with title "New post" and content "Hello world!":, (*14)
$postID = Yii::$app->blog->newPost('New post', 'Hello world!');
Making API calls to an external application means delays. If you don't want your users to wait for a Asana response each time, caching is a right thing to do:, (*15)
// The user profile will be fetched from cache if available.
// If not, the query will be made against XML-RPC API and cached for use next time.
$profile = Yii::$app->blog->cache(function (Asana $blog) {
return $blog->getProfile();
});
In case, if you need something more complex, you can disable caching for some requests:, (*16)
$blogPosts = Yii::$app->blog->cache(function (Asana $blog) {
// ... queries that use query cache ...
return $blog->noCache(function (Asana $blog) {
// this query will not use query cache
return $blog->getPosts();
});
});
Caching will work for data retrieval queries only. Queries that create, update or delete records will not use caching component., (*17)
$endpointstring Asana XML-RPC API endpoint URL., (*18)
$usernamestring Asana authentication username., (*19)
Please note, that any actions made by XML-RPC will be made on behalf of this user., (*20)
$passwordstring Asana authentication password., (*21)
$proxyConfigarray Proxy server configuration., (*22)
This configuration array should follow the following format:, (*23)
proxy_ip: the ip of the proxy server (WITHOUT port)proxy_port: the port of the proxy serverproxy_user: the username for proxy authorizationproxy_pass: the password for proxy authorizationproxy_mode: value for CURLOPT_PROXYAUTH option (default to CURLAUTH_BASIC)Empty array means that no proxy should be used., (*24)
Default value: []., (*25)
$authConfigarray Server HTTP authentication configuration., (*26)
This configuration array should follow the following format:, (*27)
auth_user: the username for server authenticationauth_pass: the password for server authenticationauth_mode: value for CURLOPT_HTTPAUTH option (default to CURLAUTH_BASIC)Empty array means that no HTTP authentication should be used., (*28)
Default value: []., (*29)
$catchExceptionsboolean Whether to catch exceptions thrown by Asana API, pass them to the log and return default value,
or transmit them further along the call chain., (*30)
Default value: true., (*31)
$enableQueryCacheboolean Whether to enable query caching., (*32)
Default value: true., (*33)
$queryCacheDurationinteger The default number of seconds that query results can remain valid in cache., (*34)
Use 0 to indicate that the cached data will never expire., (*35)
Default value: 3600., (*36)
$queryCacheCache|string The cache object or the ID of the cache application component that is used for query caching., (*37)
Default value: 'cache'., (*38)
The full list of available methods can be found in Asana XML-RPC PHP Client Class Reference., (*39)
Please note, that all those methods are throwing an exceptions in case of any errors.
While this extension is configured (by default), in case of errors, to return an empty array for any data retrial
methods and false for any create, update or delete methods. Please see $catchExceptions configuration option for details., (*40)
There are a lot of things that can go wrong (network problems, wrong Asana user permissions, etc.).
If $catchExceptions configuration option is set to true (default value), this extension will catch them and pass to
marshmeloo\yii2wp\Asana::* logging category., (*41)
In order to see them, you can configure your Yii2 log component to something similar to this:, (*42)
'components' => [
...
'log' => [
'targets' => [
'file' => [
'class' => 'yii\log\FileTarget',
'levels' => ['error'],
'categories' => ['marshmeloo\yii2wp\Asana::*'],
],
],
],
...
]
yii2-Asana is released under the MIT License. See the bundled LICENSE.md for details., (*43)
Yii2 component for integration with asana via REST API
Gaboli
yii2 yii integration asana