Flarum API Client (PHP)

luceos

[deleted] Mark, this api client isn't meant as extension. It is in fact meant to be outside of Flarum to hit the Flarum api. That's also the reason @maicol07 has been so great to make it compatible with the latest Laravel release.

[deleted]

luceos Ah, ok. My bad 🙂

EDIT: Yep, all good in fact. I'm using the API client for my RSS script, so have replaced it

Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 0 installs, 0 updates, 21 removals
  - Removing symfony/translation-contracts (v2.1.3)
  - Removing symfony/translation (v5.1.3)
  - Removing symfony/polyfill-php80 (v1.18.1)
  - Removing symfony/polyfill-php72 (v1.18.1)
  - Removing symfony/polyfill-php70 (v1.18.1)
  - Removing symfony/polyfill-mbstring (v1.18.1)
  - Removing symfony/polyfill-intl-normalizer (v1.18.1)
  - Removing symfony/polyfill-intl-idn (v1.18.1)
  - Removing ralouphie/getallheaders (3.0.3)
  - Removing psr/simple-cache (1.0.1)
  - Removing psr/http-message (1.0.1)
  - Removing psr/container (1.0.0)
  - Removing paragonie/random_compat (v9.99.99)
  - Removing nesbot/carbon (2.38.0)
  - Removing illuminate/support (v5.8.36)
  - Removing illuminate/contracts (v5.8.36)
  - Removing guzzlehttp/psr7 (1.6.1)
  - Removing guzzlehttp/promises (v1.3.1)
  - Removing guzzlehttp/guzzle (6.5.5)
  - Removing flagrow/flarum-api-client (0.1.2)
  - Removing doctrine/inflector (1.4.3)
Writing lock file
Generating autoload files
Using version ^1.1 for maicol07/flarum-api-client
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 21 installs, 0 updates, 0 removals
  - Installing voku/portable-ascii (1.5.3): Downloading (100%)         
  - Installing symfony/translation-contracts (v2.2.0): Downloading (100%)         
  - Installing symfony/polyfill-php80 (v1.18.1): Downloading (100%)         
  - Installing symfony/polyfill-mbstring (v1.18.1): Downloading (100%)         
  - Installing symfony/translation (v5.1.5): Downloading (100%)         
  - Installing psr/container (1.0.0): Downloading (100%)         
  - Installing nesbot/carbon (2.39.1): Downloading (100%)         
  - Installing illuminate/macroable (v8.0.1): Downloading (100%)         
  - Installing psr/simple-cache (1.0.1): Downloading (100%)         
  - Installing illuminate/contracts (v8.0.1): Downloading (100%)         
  - Installing illuminate/collections (v8.0.1): Downloading (100%)         
  - Installing doctrine/inflector (2.0.3): Downloading (100%)         
  - Installing illuminate/support (v8.0.1): Downloading (100%)         
  - Installing illuminate/cache (v8.0.1): Downloading (100%)         
  - Installing psr/http-message (1.0.1): Downloading (100%)         
  - Installing psr/http-client (1.0.1): Downloading (100%)         
  - Installing ralouphie/getallheaders (3.0.3): Downloading (100%)         
  - Installing guzzlehttp/psr7 (1.6.1): Downloading (100%)         
  - Installing guzzlehttp/promises (v1.3.1): Downloading (100%)         
  - Installing guzzlehttp/guzzle (7.0.1): Downloading (100%)         
  - Installing maicol07/flarum-api-client (1.1): Downloading (100%)         
symfony/translation suggests installing symfony/config
symfony/translation suggests installing symfony/yaml
symfony/translation suggests installing psr/log-implementation (To use logging capability in translator)
illuminate/support suggests installing illuminate/filesystem (Required to use the composer class (^8.0).)
illuminate/support suggests installing ramsey/uuid (Required to use Str::uuid() (^4.0).)
illuminate/support suggests installing symfony/process (Required to use the composer class (^5.1).)
illuminate/support suggests installing symfony/var-dumper (Required to use the dd function (^5.1).)
illuminate/support suggests installing vlucas/phpdotenv (Required to use the Env class and env helper (^5.0).)
illuminate/cache suggests installing ext-memcached (Required to use the memcache cache driver.)
illuminate/cache suggests installing illuminate/database (Required to use the database cache driver (^8.0).)
illuminate/cache suggests installing illuminate/filesystem (Required to use the file cache driver (^8.0).)
illuminate/cache suggests installing illuminate/redis (Required to use the redis cache driver (^8.0).)
illuminate/cache suggests installing symfony/cache (Required to PSR-6 cache bridge (^5.1).)
guzzlehttp/psr7 suggests installing zendframework/zend-httphandlerrunner (Emit PSR-7 responses)
guzzlehttp/guzzle suggests installing psr/log (Required for using the Log middleware)
Writing lock file
Generating autoload files
8 packages you are using are looking for funding.
Use the `composer fund` command to find out more!

maicol07

Release 1.1.1

This release fixes an issue.

Changelog

🐛 Fixed

Can't install on Laravel 6 & 7
⚠️ WARNING! If you use Laravel 6 you won't be able to run PHPUnit tests
⚠️ Laravel 6 & 7 will be supported until Laravel supports them with security fixes. Laravel Support Policy

krapas

Can only install one of: illuminate/cache[v8.0.2, v5.7.28]?

maicol07

krapas I'm not sure if I've understood the question, but Laravel 5 is not supported. Only Laravel versions supported by the Laravel Foundation are supported. So, please update to Laravel >= 6

maicol07

Release 1.1.2 - Guzzle 6 support

This release adds support for Guzzle 6, adds a new test and fixes a bug with tests.

Changelog

➕ Added

Guzzle 6 support
- ⚠️ Guzzle 6 will be supported during until its EOL
User test

🐛 Fixed

Tests error when composer packages has been updated

maicol07

Release 1.2

Changelog

➕ Added

Added request headers (see the header method)

Release 1.2.1 & 1.2.2

Changelog

➕ Added

Missing docs

🐛 Fixed

Exception Uncaught Typerror...

krapas

How to install laravel 6 in centos linux?

maicol07

r4nchy are you trying to install the api client on a flsrum instance?

krapas I don't think this is the correct place to ask. Please check the official website and docs: https://laravel.com/
If you have trouble write a post on the Laracasts forums.

r4nchy

I am getting this error

Magnus_Lind

Really nice work 👍️

After some struggling I got it up and running and managed to connect and list posts and discussions. I found the API docs at https://api.docs.flarum.org/ but I really cannot figure out how to do stuff, like just make a post as a user for instance. How do I proceed? Using the examples provided on github and authentication with api keys are all setup.

<?php

require_once "vendor/autoload.php";

use Maicol07\Flarum\Api\Client;

$api = new Client('https://myforum.com', ['token' => 'mylongtoken; userId=123']);

$discussions = $api->discussions(289)->post();

maicol07

Magnus_Lind sorry for the late reply (I've seen now the post 😅 ).
Currently, docs are lacking examples. However, there is some production ready code in PHPUnit tests...
Regarding your case you should pass an array as the post function parameter. To know what there should be inside you can examine Flarum via your browser developer tools (generally, press F12): when you create a post in a discussion you should see an XHR request in the network tab. Check the request params from there

Scumi

@maicol07
During my forum update to beta 15 I observed that I am not able to use the username (string) anymore when requesting a user via this api client.

$this->api->users($username)->request();

Using the id (int) however still works.

$this->api->users($userid)->request();

Can you confirm this? Maybe Flarums API has changed between beta 13 and beta 15.

tankerkiller125

Scumi This is accurate, we changed the way the API works in order to fix some other bugs and issues and also to be more compliant with the JSON-API specs. If you need to get a user by slug you can do so by adding the bySlug=true URL parameter. So something like example.com/api/users/<username>?bySlug=true I'm not sure how you would do that with this SDK/API but it is possible.

ctml

tankerkiller125 does this fix the issue where api query to a username starting with a number would try to look them up via userid?

E.g. Username 510889, user ID = 60
Query to user api for 510889 would return null unless you had that many users registered.

Scumi

Thanks, I can work with that.

tankerkiller125

ctml Yes, that would indeed be the fix. We actually originally just did this for the purpose of the custom slugging extender but the added side effect was fixing that bug. @010101 would be an example to test that it actually works correctly.

(Sorry @010101, you just are the example that comes to mind)

maicol07

Release 1.2.3

This small release fixes a bug with users API, when getting them by username/slug.

🛠️ Fixed

🐛 Get user by username returning 404 (beta15 incompatibility; thank you @Scumi for noticing this)

Note: Now the users endpoint parameter follows this standard:

int parameter: get user by id
string parameter: get user by slug/username

For example:
Parameter: 012453 - I get user with ID 012453
Parameter: '012453' - I get user with username 012453

This update shouldn't be a breaking update, so everything should work fine without anything else

maicol07

Release 1.3

This release focuses on adding minor features and removing support for Laravel 6 & 7 and Guzzle 6, in order to follow Flarum decisions with beta16. This changelog is a little different from the previous ones (new format! Tell me if you like it or the previous ones were better)

➕ Added

feat: ✨ Accept id as a string (for user endpoint) - The id() method can now accept a string parameters (like the user() method)
feat: ✨ `addQueryParameter` method is now public! - Public method = You can use it too! You can now add query parameters to the request

📈 Improved

docs: 📝 Updated docs and docs: 📝 Improved and added PHPDocs - New API docs website design. Some missing PHPDocs added and some updated.
tests: ✅ Updated tests

🗑️ Changed/Removed

chore(deps): 💥 📌 Removed support for Laravel 6 & 7. Requires PHP 7.3 - As commit says, now the api client requires PHP 7.3 and using it with Laravel 6 & 7 is no more supported. You can update or stick with version 1.2.3
chore(deps): 💥 Removed support for Guzzle 6 - Same as above.

zoocreative

Perhaps I am being an idiot here (not uncommon) but I can query Flarum with request() e.g. get a list of tags, but the returned items are protected and I can't seem to access them? Do I need to use a getter to view these items?

Cheers for any help.

maicol07

zoocreative the returned object is a Laravel collection, which is a better array implementation. You can use any of the collection methods to get elements. You can get the array with all the elements with the all() method (check the links to read more about collections).