I AM LISTENING TO
|
WHAT I LIKE
  • English
  • German


BLOG FILTER



18. November 2015

PHP & API Documentation

Currently refreshing my list of options to document projects and APIs.

I will use this page to keep a list of possible tools & solutions.

PHP DOCUMENTATION

  1. PHPDocumentor
  2. phpDox – The PHP Documentation Generator
  3. Sami: an API documentation generator
  4. apigen (PHP 5.4+)
  5. Doxygen
  6. Dexy

API DOCUMENTATION

  1. JSDoc
  2. API Blueprint
  3. Swagger.io
  4. apiary – API Design Stack
  5. APIDOC – RESTful web APIs
  6. ESDoc – JavaScript(ES6)
  7. doxx – Generic, template based, HTML output for Dox documentation generator
  8. documentation.js – raw documentation as JSON, beautiful, customizable HTML, or Markdown that fits perfectly into an API.md or README.md

Enjoy coding …

readmore

Really cool interface to test and debug Regex. The website also includes a nice regex library.

regex101.com

 

readmore

“WP-CLI is a set of command-line tools for managing WordPress installations”

 

WP-CLI

readmore

Using WordPress as a headless system, is nothing new. You can easily build out your own REST API or use the long available HTTP REST API 1.0+ for WordPress.

But with the new HTTP REST API 2.0+ its getting really easy to build out your own REST API Namespace and assign routes for all your JSON needs.

The new REST API will make its appearance in WordPress 4.4, but you can start now by adding the plugin to your system. When the plugin detects 4.4+ it will only load functionality not already present in the core.

A ROUTE

A route tells the API to respond to a given request with a specific function (endpoint). This adds the permalink structure to WordPress so that your functionality can be accessed via an url like this: http://yourdoman.com/wp-json/yourplugin/v1/myfunction/your_parameter 

THE ENDPOINT

The Endpoint is the callback handled by the route. Each endpoint can have additional parameters attached:

  1. custom permissions
  2. default values
  3. sanitization callback
  4. validation callback
  5. field requirements and more

RETURN VALUE

The return values from the endpoint are converted into JSON. You can use the WP_REST_Response object , this wraps normal body data and allows you to return a custom status code.

Really powerful stuff, that makes it easy to detach WordPress and the actual client using the data provided by it.

You can read more about it here.

Enjoy coding …

readmore

Some options to get those translatable strings out of your templates. I will be adding new things, as I discover them :)

  1. xgettext-templateHandlebars & Swig
  2. gettext-twig – {% trans “string here” %}
  3. rtwix – Ruby based TWIG translations extractor
  4. twig-po – Extract translation keys from twig templates and move them to PO
  5. Twig-Gettext-Extractor –  tool which extracts translations from twig templates

Enjoy coding …

readmore

Flarum is new elegant next-generation forum software. It provides a touch optimized two pane layout with floating composer.

The backend runs on PHP/MySQL.

Flarum

readmore
31. October 2015

Timber , TWIG & PoEdit

Timber / Twig templates are normally not recognized by Poedit. Its just a matter of tweaking the C/C++ extractor within the settings panel.

Add TWIG to the filetypes: *.c;*.cpp;*.h;*.hpp;*.cc;*.C;*.cxx;*.hxx;*.twig

Gettext calls, like {{__(“Points Conversion Rate”, “wplms-extras”)}} in Timber, are being extracted from your templates after that.

Easier than using the gettext extractor :)

ADDING GETTEXT FUNCTION TO TWIG

 

Enjoy coding …

 

readmore

Excel needs to know that you are using non-ASCII characters in your CSV or it will not display them correctly :)

Add the BOM(Byte Order Mark) to the first line, notifying Excel that you are offering a UTF-8 encoded file.

Enjoy coding …

readmore

I am currently working on a WPLMS enhancement for a customer, that allows to simplify the payout of instructor commissions. The whole system runs on the MyCred Points System and students pay for courses with Points. The problem is how to easily payout the instructor commissions via PayPal.

There is currently no addon for MyCred available that does that magic, so I build one myself.

At the moment the payment process via PayPal is completely manual, due to budget constraints. I am basically generating a custom “Send Money” link that prefills the PayPal email and amount to send.

The interface itself handles the payout sessions, tracks the instructor balance, paid and unpaid points.

Here some images to illustrate the admin dashboard:

wplms_points_payout

This list the instructors and their point balance and allows to start the payment process.

wplms_points_payout2

Payout sessions make sure, that only one session can be started per instructor, as the instructor could earn new points during the process. The points converted can be changed, allowing you to payout a fixed amount of points.

Its a 3 step process. Login at PayPal. Open the “Send money” dialog and send money to instructor. Confirm that you manually send the money and than register the payment and payout points in the system.

wplms_points_payout3

The session can be cancelled at any point. You can also leave the session open and continue at a later point.

wplms_points_payout4

On the frontend I added an interface to the BuddyPress Profile, that allows the instructor to track his payouts and balance.

wplms_points_payout5

The whole setup could be updated using PayPal Adaptive Payments, to make the whole process completely automated. Something to consider for the future :) Pretty happy with the manual process so far and it will be a great help for my customer to keep track of the commission payouts.

The whole setup is currently targeted for WPLMS, but can easily be adapted to other setups using the MyCred Points System.

Enjoy coding …

 

 

readmore
20. October 2015

WordPress Plugins & Sessions

START SESSION ON INIT

NEW SESSION ON LOGIN / LOGOUT

Now go ahead and use $_SESSION freely in your plugin. Here a nice additional class to  encrypt session data.

Enjoy coding ….

readmore