Download the PHP package decole/planka-php-sdk without Composer

On this page you can find all versions of the php package decole/planka-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of decole/planka-php-sdk

Informations about the package planka-php-sdk

PHP PLANKA REST API

Wrapper over the rest api of the Planka (https://github.com/plankanban/planka)

Tested on Planka version:

Implemented all entrypoints for the bar version 1.10.3 and later.

Install

composer require decole/planka-php-sdk

How to use

Wrapper executes the requests that Planka makes over the web socket or hidden REST API. Wrapper use hidden REST API. See endpoints in https://github.com/plankanban/planka/blob/master/server/config/routes.js

To understand how to use the wrapper, you can go to the web socket and see how the web client of the web socket works with its server. Requests and responses are identical. I just standardized the answers in the DTO. The data inside the DTO is identical to the server responses.

It is also not important to understand that you are working under a specific user. Accordingly, if you do not see a project or some board, this means that this user is prohibited from having access by access rights.

You need to add a user. For which you come as a wrapper in the projects and boards you need.

Wrapper endpoint - /src/PlankaClient.php

Example - Delete empty board

You can test this bundle for Rest API with a test script, in the folder /tests/index.php. There you will find the main examples of using the script.

Copy config.example.php for config.php and customize to your Planka credentials.

In the test script, comments describe what is being done and the project, board and card are also created and carried out with them manipulations, at the end of the card, board and project are deleted.

All necessary entrypoints are conveniently divided into controllers. You can view the controllers in the src/Controllers/ folder.

Result data output is strongly typed and returned in Dto objects

Found problems:

Using Symfony\Component\HttpClient\NativeHttpClient - as an internal client, you can send passwords with special characters ()\|/"' but if you use Symfony\Component\HttpClient\CurlHttpClient - tricky passwords cannot be used. inside there is escaping for url encoding, which is why Planck the password cannot be intact. Because of this, it is impossible to log in with an account.

For develop

RTFM

Static analyze code

Psalm analyze: ./vendor/bin/psalm --no-cache --no-file-cache

Or if you use linux, use make psalm

All versions of planka-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1.0
symfony/http-client Version ^6.2
symfony/mime Version ^6.2
fp4php/functional Version ^5.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package decole/planka-php-sdk contains the following files

Loading the files please wait ....