Projects API implementation into the PHP Client for Makerlog
Projects API implementation into the PHP Client for Makerlog
As I already mentioned, I develop the PHP client for Makerlog in my spare time. Makerlog is the dead-simple task log that helps you stay productive and ship faster. There you can meet other makers and share your progress.
Today I finished the Projects API and laid the groundwork for the Products API.
Repository
- https://github.com/pcsg/pcsg-makerlog-php-client
- Licence: GPL-3.0+
New Features
What feature(s) did you add?
- I implemented the Projects API.
/projects/GET, POST/projects/{id]/GET, PATCH, DELETE/projects/{id}/related/
How did you implement it/them?
The implementation is done with the following commits
In addition, I have written a basic documentation.
Again I give a small overview how the two new objects Project and Porjects can be used. Basically, I stuck to the other API, so similarities are not surprising.
As mentioned above, there are two new objects
- Projects
- Project
Projects in Makerlog are more like hashtags for products. Unfortunately the naming is a bit confusing but since I write a client for the network, I prefer to stick to the names of the respective network and don't introduce any more names.
How to get the main Projects Object
The main Projects object is directly available via the makerlog client
Create a project
To create a new project, you must use the projects object.
Get a project
A single project can be received via its id
With a normal project which has been received via get(), no operations can be executed. If you want to change the project, you should get a project object. This can be done via getProjectAsObject().
A project object has several getter methods, so it is quite easy to access the data of the project.
Change a project
After creating a project it is possible to change or delete the project.
GitHub Account
Of course you can find all examples in the new projects documentation as well.
With the changes and features of today it is now possible to create, read, update and delete projects. In the coming days the product API for which you need the Projects API will be integrated.
Have fun in Makerlog and thanks for reading,
Hen
Thank you for your contribution.
Your
isPrivate(and alsoisPublicmethod seems a code smell to me because it has a general-exception-catcher.. This method should be as simple as->privateand if there is exception e.g. getProjectData() is null, then let the exception be thrown and get caught earlier.. See this post for more details.Your
isPublic()could be justreturn !this->isPrivate()which removes the code duplication.Code duplication for example, the Project and Product both have same implementation of
refresh()could this be moved to a parent class?Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Chat with us on Discord.
[utopian-moderator]
Thank you for your review, @justyy! Keep up the good work!
hola soy aspirante a programador pero en mi pais no se ve esta profesión que me recomiendas para empezar a aprender por mi cuenta?
Hi @dehenne!
Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server
Hey, @dehenne!
Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!
Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).
Want to chat? Join us on Discord https://discord.gg/h52nFrV.
Vote for Utopian Witness!
Bro How to start Steempunk? There's no option to login or signup how do I get started?
Posted using Partiko Android
Congratulations @dehenne! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :
You can view your badges on your Steem Board and compare to others on the Steem Ranking
If you no longer want to receive notifications, reply to this comment with the word
STOPDo not miss the last post from @steemitboard:
Vote for @Steemitboard as a witness to get one more award and increased upvotes!