Start up:

1. run make -C .docker-fapi-member dc-up-front (pro macbook si doplnit do docker-compose.yml k db: platform: linux/x86_64)

2. open browser and go to page http://localhost:8080

3. install wordpress

4. enable FAPI Member plugin in plugin section

5. develop plugin

Poznámky

Vývoj

Původní vývoj

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

Refactoring back-endu (2024)

Celý backend aplikace byl předělán. Až na některé vyjímky byla zachována struktura ukládaných dat, ale celá aplikace byla předělána do OOP. Bylo zjednodušeno zasílání e-mailů, kdy je již pro nahrazení zástupných symbolů potřeba znát pouze stav původního členství a nového členství.

Refactoring front-endu (2024)

Byly zahozeny php šablony a celý front-end byl předělán do reactu. Byla vytvořena nová verze API (v2), která je používána při komunikaci s front-endem. API v2 je momentálně pouze interní a není možné na ni posílat dotazy z jiných webů.

Datové struktury

Plugin nedělá zásah do DB.

Členství

Č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í

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ě

Úrovně jsou uloženy jako neveřejná taxonomie s názvem v FapiLevels::TAXONOMY.

Nastavení úrovně

Úroveň má své stránky, nastavení emailů a ostatních stránek uloženo v term meta: fapi_pages, fapi_email_*, fapi_page_*

Globální nastavení

Plugin si ukládá data i do options: fapiMemberApiChecked, fapiSettings, fapiMemberApiKey, fapiMemberApiEmail

API a callback

Většinou publikované routy fungují jen s url rewritingem, tyhle ošklivé níže by měly být univerzálnější.

URL pro definované sekce a úrovně

[site]/?rest_route=/fapi/v1/sections

Callback url

[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

Chybové kódy

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ší

Odinstalace pluginu

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ů

Transpilace JS a CSS

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

Build Reactu pro Divi / fix node_modules

• make divi-build

• Pokud nemáte stažené node_modules - fix

  • cd src/Divi
  • (nvm install 14)
  • nvm use 14
  • npm install
  • cd node_modules/divi-scripts
  • npm install --save-dev webpack@3.10.0
  • jít do souboru /fapi-member/src/Divi/node_modules/divi-scripts/scripts/utils/verifyPackageTree.js
  • pod řádek 18 přidat return;
  • nvm use 22 Nebo jinou verzi, kterou používáte

Testovací akce

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.

Build a nasazení na WP

POUZE POKUD VÍŠ CO DĚLÁŠ

1. Změnit verzi v souborech make update-version version=x.x.x
   1. zkontrolovat fapi-member.php' - všude kde je uvedena verze
   2. zkontrolovatreadme.txt - všude kde je uvedena verze a napsat changelog
2. Připravit deploy make prepare-deploy version=x.x.x
3. Případně otestovat aplikační build na živém webu
   1. Po prepare-deploy se vytvoří složka wp-build-test se zipem produkčního buildu aplikace
   2. Nahrát soubor na živou verzi WordPressu a otestovat, jestli vše funguje
4. Otevřít složku wp-svn cd wp-svn
5. Dát do stavu track svn add --force * --auto-props --parents --depth infinity -q
6. A vše commitnout svn ci -m '{Message s update zprávou}' --username fapi --password '{your_password}'