Skip to content

Diagrams added #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .distignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/.github
/bin
/build
/diagrams
/docs
/githooks
/legacy-tests
Expand All @@ -14,6 +15,7 @@
.gitignore
.scrutinizer.yml
Changelog.md
Diagrams.md
README.md
composer.json
composer.lock
Expand All @@ -25,5 +27,4 @@ phpdoc.xml
phpstan.neon
phpunit.xml
playwright.config.ts
setup.sh
plantuml_gist.puml
setup.sh
6 changes: 5 additions & 1 deletion Diagrams.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@

Infrastructural overview about the plugin's PHP classes:

![PlantUML class diagram](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/lloc/multisite-language-switcher/master/plantuml_gist.puml)
![PlantUML class diagram](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/lloc/multisite-language-switcher/master/diagrams/msls-class.puml)

Package diagram:

![PlantUML class diagram](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/lloc/multisite-language-switcher/master/diagrams/msls-package.puml)
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"prepare": "wget -O build/translations.json http://api.wordpress.org/translations/core/1.0/",
"flags-png": "php bin/flags-png.php > flags/flags.php",
"flags-svg": "php bin/flags-svg.php > css/flags.php",
"diagram": "vendor/bin/php-class-diagram --php7 includes > plantuml_gist.puml",
"diagram:class": "vendor/bin/php-class-diagram --php7 includes > diagrams/mslsl-class.puml",
"diagram:package": "vendor/bin/php-class-diagram --package-diagram --php7 includes > diagrams/msls-package.puml",
"githooks": [
"if [ -e ./githooks/pre-commit ]; then cp ./githooks/pre-commit ./.git/hooks/; fi",
"if [ -e ./.git/hooks/pre-commit ]; then chmod 0755 ./.git/hooks/pre-commit; fi"
Expand Down
Loading
Loading