Flagrow generic PHP API client for Flarum installations

Franz

Cool project.

A general comment: Instead of method signatures like createTag($title, $slug), you might want to think about using options hashes, like so createTag(['title' => 'Amazing Title', 'slug' => 'amazing-slug']). That way, the parameters are self-explanatory, and it's also more extensible and, thus, future-proof.

luceos

Franz the latest version i committed even has abstracter methods like create, taking the type as first argument 😉 The other functions; specific ones are to document how to work with those abstracter methods. And the reason for exactly specifying the arguments/attributes is to show which values are required and optional, something which is currently hard to identify.

tarun

This is a really brilliant idea luceos.. besides making it really easy to use the API, its also going to ensure Flarum has 100% API coverage! Kudos to you.

erguner

How to create a discuss with a tag ?

luceos

I've released 0.2.0-beta.1 which is a complete rewrite from the original code adding a Fluent API request builder. It features some limited functionality for now and needs quite some documentation to explain what the Fluent builder can do.

Flagrow is going to actively use this library, so feel free to use it as well without the risk of not being maintained.

Please note 0.2.0 and up require PHP 7.1, because reasons and ? .

Davis

Good work!

luceos Please note 0.2.0 and up require PHP 7.1, because reasons and ? .

PHP 5.6 is no longer being actively maintained and Laravel 5.5 will require PHP 7 so this isn't surprising. ?

jordanjay29

Davis If only we could tell shared hosts this little secret.

ganuonglachanh

Can someone provide an example like create new user, new discussion, new post?

Thanks!

ganuonglachanh

@luceos

Sorry for tagging you, can you help me on this?

luceos

ganuonglachanh I'll look into adding something that makes this easier.

iosmall

luceos
Can someone provide an example like create new user, new discussion, new post?

Thanks!

yekenuk

I've not used it - but great addition. @luceos, do you ever sleep?! ?

jordanjay29

yekenuk @luceos doesn't sleep, he RESTs.

iosmall

8.1 compatible?

luceos

iosmall it should work.

For everyone asking for examples updates etc, feel free to fork and do whatever you want with the code. It's mit licensed.

ctml

This might be an issue in core, and if so I can make an issue in github, but the API appears to have a bug dealing with numerical usernames. As it allows calls to /api/users using the ID or username, if a numerical username is used it will check type and do lookup on the ID only. This is my assumption based on testing, example below.

e.g.

username: 8128084
id: 2

GET /api/users/2
Returns HTTP 200

GET /api/users/8128084 
Returns HTTP 404

Change the username and add a character to the number, and the api call starts working.

e.g.

username: 8128084s
id: 2

GET /api/users/8128084s
Returns HTTP 200

luceos

ctml it's a known core issue relating to that endpoint.

maicol07

The API client is now maintained by me and has a new thread and a new home