https://github.com/fapi-cz/fapi-member
https://github.com/fapi-cz/fapi-member
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fapi-cz/fapi-member
- Owner: fapi-cz
- Created: 2021-09-29T10:31:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T11:55:12.000Z (about 2 years ago)
- Last Synced: 2024-05-29T03:21:29.026Z (about 2 years ago)
- Language: PHP
- Size: 2.43 MB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 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](https://cs.wordpress.org/about/requirements/)
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í:
~~~json
[
{
"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.
# Překlady
Test funkčnosti CLI:
Musí přejít do složky s docker-compose.yml
docker compose run --rm wpcli core version
1. Vygeneruje POT file. Tedy seznam všech překladových řetezců.
```
docker compose run --rm -e WP_CLI_PHP_ARGS='-d memory_limit=768M' wpcli \
i18n make-pot \
wp-content/plugins/fapi-member \
wp-content/plugins/fapi-member/languages/fapi-member.pot \
--domain=fapi-member \
--exclude="node_modules,build,dist,vendor,*.min.js,assets/js/vendor,wp-build,wp-svn,wp-build-test"
```
2. Pokud již máš existující .po soubory a chceš je pouze aktualizovat (zachovat původní překlady a doplnit nové řetězce):
```
for lang in cs_CZ en_US es_ES sk_SK hr_HR hu_HU de_DE vi_VN pl_PL ro_RO ru_RU it_IT pt_PT fr_FR zh_CN sl_SI; do
msgmerge --update --no-fuzzy-matching --backup=none fapi-member-$lang.po fapi-member.pot
done
```
3. BUILD překladů, vygenerování MO souborů, které se v produkci používají pro překlady
```
for lang in *.po; do
msgfmt $lang -o "${lang%.po}.mo"
done
```
4. Vygeneruje JSON soubory pro React/JS překlady. Nejdřív smaže všechny existující JSON soubory a pak vygeneruje nové.
```
rm -f languages/*.json
cd .docker-fapi-member
docker compose run --rm -w /var/www/html/wp-content/plugins/fapi-member wpcli \
i18n make-json languages --no-purge
```
# Build a nasazení na WP
## POUZE POKUD VÍŠ CO DĚLÁŠ
Koukni na: https://youtu.be/ypv-TVbMtcs
1. Prvně si udělat rebase s origin/master - poté pokračuj viz níže
2. Připravit deploy `make prepare-deploy version=x.x.x` (Pokud nemám nainstalované svn, tak první `brew install subversion`)
3. zkontrolovat verzi v souborech
1. zkontrolovat `fapi-member.php`' - všude kde je uvedena verze
2. zkontrolovat`readme.txt` - všude kde je uvedena verze a napsat changelog
4. 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
5. Otevřít složku wp-svn `cd wp-svn`
6. Dát do stavu track `svn add --force * --auto-props --parents --depth infinity -q`
7. A vše commitnout do WP `svn ci -m '{Message s update zprávou}' --username fapi --password '{your_password}'`
8. Následně vše commitnout do Githubu!!!