Download the PHP package takuya/php-nulab-backlog-api-client without Composer

On this page you can find all versions of the php package takuya/php-nulab-backlog-api-client. 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 takuya/php-nulab-backlog-api-client

Informations about the package php-nulab-backlog-api-client

Nulab Backlog APIアクセス用

目標：NulabのBacklog APIに快適にアクセスして、全データを取り出せるようにする。

バックログのスペースとプロジェクト内部を探索してデータを探すのが面倒なので、データを網羅的に探せるようにしてある。

基本的な使い方。

spaceId はURLを入れます。

提供するクラス

２つのクラスファイルを提供しています。

class Backlog はID探索のために作っています。更新は実装していません。 class BacklogAPIClient を使って更新をします。

認証

APIキーのアクセスを実装しています。OAUTHアクセスキー（BEARERトークン）は実装していません。

特長

PHPStormのIDE自動補完を使えるようにした。

データモデルをModelクラスとして作成した。これによりスペース→プロジェクト→課題->コメント->通知 のBacklog階層構造を辿れる。

階層構造でたどれば、全体を取得しやすくなる。

サンプル

自動補完の例

BacklogのAPIのメソッド名を自動補完します。

image

サンプル

APIはバックログを開いてアドレスを見ながら使います。

課題コメントを開いたときのアドレスは次のようになっています。

アドレスから次の情報が読み取れます。

URL(path) 値 Apiでの引数表記 呼び方
/MYPRJ-40#comment-8408 MYPRJ ProjectIdOrKey ProjectKey
/MYPRJ-40#comment-8408 40 IssueIdOrKey IssueKey
/MYPRJ-40#comment-8408 8409 CommentId CommentId

APIドキュメントにProjectIdOrKeyと書かれた場合は、 ProjectId Or ProjectKey を意味しています。ProjectKeyとProjectIdとは１対１対応のようです。 上記の情報を使ってAPIにアクセスします。

たとえば、以下のように使います。

基本的に、KeyよりIDアクセスが楽ちんです。

なぜなら、リクエスト引数へIDsを指定で検索するAPIが殆どだからです。たとえばパラメータprojectIds[]やIssueIds[]などです。

このためにID と Key を相互に変換するメソッドを作成してあります。

api 一覧

APIの名前とメソッド名と実際のAPIの対応表をapi.htmlに用意しています。

日付と時刻

BacklogのAPIは created / updated で日付が返されます。すべてUTCのようです。

インストール via github

インストール via packagist with composer

Development

インストールしてテストして開発。

サンプル

更新をするときのサンプル

画像の投稿のサンプル

画像を投稿して、画像を貼り付けたコメントを作る。

All versions of php-nulab-backlog-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
guzzlehttp/guzzle Version >=7.5
ext-json Version *
ext-gd Version *
takuya/php-genetator-array-access Version ^1.0
doctrine/inflector Version ^2.0
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 takuya/php-nulab-backlog-api-client contains the following files

Loading the files please wait ...