-
run
make -C .docker-fapi-member dc-up-front
(pro macbook si doplnit do docker-compose.yml k db: platform: linux/x86_64) -
open browser and go to page
http://localhost:8080
-
install wordpress
-
enable FAPI Member plugin in plugin section
-
develop plugin
Plugin kód není moc pěkný, ale snažil jsem se maximálně využit Wordpressu a nestavět vedle WP nějaké další (cizí) struktury a způsoby (autoloading, šablony...), které by ale pro větší projekt určitě byly potřeba.
Obzvláště nehezké jsou věci kolem reakce na callback a posílání mailů.
Uvažoval jsem nad možností to přepsat, ale zase jsem se neodvážil dělat
abstrakce a předjímat něco, protože myslím, že maily (pravidla, počet...) se určitě
budou měnit a ten systém s postupným plněním $props
je nejpružnější, co mě napadl.
Taky je použita stará verze PHP - protože WP zatím podporuje PHP 5.6.20
Plugin nedělá zásah do DB.
Členství je uloženo jako meta k uživateli pod klíčem v FapiMembershipLoader::MEMBERSHIP_META_KEY
.
Struktura je následující:
[
{
"level": 12,
"registered": "2020-01-01T20:00:01",
"until": "2020-01-01T20:00:01",
"isUnlimited": true
},
{
"level": 10,
"registered": "2020-02-01T20:00:01",
"until": "2020-04-01T20:00:01",
"isUnlimited": false
}
]
Historie členství je uložena jako user meta po klíčem v FapiMembershipLoader::MEMBERSHIP_HISTORY_META_KEY
.
Ukládá se pole serializovaných FapiMembership objektů.
Úrovně jsou uloženy jako neveřejná taxonomie s názvem v FapiLevels::TAXONOMY
.
Úroveň má své stránky, nastavení emailů a ostatních stránek uloženo v
term meta: fapi_pages
, fapi_email_*
, fapi_page_*
Plugin si ukládá data i do options: fapiMemberApiChecked
, fapiSettings
, fapiMemberApiKey
, fapiMemberApiEmail
Většinou publikované routy fungují jen s url rewritingem, tyhle ošklivé níže by měly být univerzálnější.
[site]/?rest_route=/fapi/v1/sections
[site]/?rest_route=/fapi/v1/callback&level[]=1&level[]=2&days=31
V těle požadavku očekávám url encoded string jako:
id=187034262&time=1614239639&security=9edbc14e1905b61af468217f60d2406d160c4fdf
kde id
použiju na načtení objednávky, time
a security
pro validaci
Callback vrací při chybě status code 400
a chybový text, jsou "ošetřeny" následující stavy:
- Nepodařilo se načíst invoice/voucher z API
- Voucher status není
applied
- Nelze najít email zákazníka v API response
- V get parametrech callbacku chybý proměnná
level
- Některá sekce/úroveň z callbacku neexistuje ve WordPressu
- Invoice / voucher security hash nesedí
- a další
Plugin při deaktivaci nedělá nic. Při smazání pluginu před administraci WP se:
- odebere taxonomie
- odeberou options
- odeberou user_meta všech uživatelů
Css je zapsáno v scss (https://sass-lang.com/documentation/cli/dart-sass), pro kompilaci do css:
npm run css
Javascript je transpilován webpackem, pro kompilaci po úpravách:
npx webpack
Pokud ve wp_options
nastavíte klíč fapiIsDevelopment
na hodnotu 1
, pak se
v menu pluginu objeví červená možnost Testovací akce, která umožní spustit obsah souboru templates/test.php
,
to je možné využít při vývoji na testování např. zakládání uživatelů, posílání mailů atd.
- Je potřeba udělat build jak js tak css souborů
- Změnit verzi balíčku
- změnit verzi v
fapi-member.php
' - všude kde je uvedena verze - změnit verzi v
readme.txt
- všude kde je uvedena verze
- změnit verzi v
- Připravit deploy
make prepare-deploy version=x.x.x
- Otevřít slořku wp-svn
cd wp-svn
- Dát do stavu track
svn add --force * --auto-props --parents --depth infinity -q
- A vše commitnout
svn ci -m '{Message s update zprávou}' --username fapi --password '{your_password}'