codelinered / slim-skeleton
Slim Skeleton - CodelineRed
Requires
- php: 8.0.*
- doctrine/annotations: ^1.13
- doctrine/orm: ^2.13
- geggleto/psr7-acl: ^1.3
- google/recaptcha: ^1.2
- monolog/monolog: ^1.27
- nochso/html-compress-twig: ^2.0
- paragonie/random_compat: >=1 <9.99
- phpgangsta/googleauthenticator: dev-master
- ramsey/uuid-doctrine: ^1.8
- slim/csrf: ^0.8.3
- slim/flash: ^0.4.0
- slim/slim: ^3.12
- slim/twig-view: ^2.5
- symfony/cache: ^6.0
- symfony/console: ^6.0
Requires (Dev)
- phpunit/phpunit: >=4.8 < 6.0
- dev-master
- 5.x-dev
- 5.6.0
- 5.5.0
- 5.4.1
- 5.4.0
- 5.3.0
- 5.2.0
- 5.1.1
- 5.1.0
- 5.0.9
- 5.0.8
- 5.0.7
- 5.0.6
- 5.0.5
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.x-dev
- 4.3.2
- 4.3.1
- 4.3.0
- 4.2.2
- 4.2.1
- 4.2.0
- 4.1.0
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
- 3.x-dev
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.2
- v3.2.1
- v3.2.0
- 3.1.4
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.x-dev
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.1.0
- 1.0.1
- 1.0.0
- dev-production
- dev-develop
This package is not auto-updated.
Last update: 2024-11-04 18:24:12 UTC
README
This git is for slim3.codelinered.net. Take a look at screenshots.
Table of contents
- Included Third Party Code
- Install Guides
- Path generation with Locale code and Generic locale code
- How to create further localisations
- How to switch between different url modes
- ACL settings
- Troubleshooting
- Links
Included
- Slim 3
- Slim Twig View 2
- Slim CSRF 0.8
- Slim Flash 0.4
- Monolog 1
- Doctrine ORM 2
- Geggleto ACL 1
- Google Authenticator
- Google reCAPTCHA 1
- HTML Compress Twig Extension
Install Skeleton
Required
- PHP 8.0
- MySQL 5.7 (pdo_mysql)
Open console on your OS and navigate to your project folder. Download zip if you don't have git or composer on your OS.
+++++ ZIP VERSION +++++ $ (unix) wget -O slim-prod.zip https://github.com/CodelineRed/slim-skeleton/archive/production.zip $ (unix) unzip slim-prod.zip $ (win10) curl -L -o slim-prod.zip https://github.com/CodelineRed/slim-skeleton/archive/production.zip $ (win10) tar -xf slim-prod.zip $ cd slim-skeleton-production $ (optional) cp config\additional-settings.dist.php config\additional-settings.php $ ---- Open "config\additional-settings.php" and change everything you have to change ---- $ php composer insall --no-dev $ php doctrine dbal:run-sql "CREATE DATABASE slim_skeleton" $ php doctrine orm:schema-tool:update --force $ php doctrine dbal:import sql/all-records.sql
+++++ GIT VERSION +++++ $ git clone https://github.com/CodelineRed/slim-skeleton.git $ cd slim-skeleton $ git checkout production $ (optional on unix) rm -rf .git $ (optional on win10) rmdir .git /s $ (optional) cp config\additional-settings.dist.php config\additional-settings.php $ ---- Open "config\additional-settings.php" and change everything you have to change ---- $ php composer insall --no-dev $ php doctrine dbal:run-sql "CREATE DATABASE slim_skeleton" $ php doctrine orm:schema-tool:update --force $ php doctrine dbal:import sql/all-records.sql
+++++ COMPOSER VERSION +++++ $ php composer create-project codelinered/slim-skeleton slim-skeleton "dev-production" --no-dev $ cd slim-skeleton $ php doctrine dbal:run-sql "CREATE DATABASE slim_skeleton" $ php doctrine orm:schema-tool:update --force $ php doctrine dbal:import sql/all-records.sql
Default Website login: user = user, pass = password If you need PHP, MySQL, Composer and Adminer, see below ⇓.
Install PHP, MySQL, Composer and Adminer (optional)
Required
Open console on your OS and navigate to the unziped/ cloned app folder.
$ (unix) systemctl docker start $ (windows) "c:\path\to\Docker Desktop.exe" $ docker-compose build $ docker-compose up -d $ docker-compose run composer install --no-dev $ (unix) docker inspect slim-db | grep "IPAddress" $ (windows) docker inspect slim-db | findstr "IPAddress" $ ---- Add IPAddress as Doctrine "host" in "config\additional-settings.php" ----
Open localhost:7705 for Website or localhost:7707 for Adminer.
Path generation with Locale code and Generic locale code
- Mode 1 - example.com/de/ =
'process' => \App\Utility\LanguageUtility::LOCALE_URL | \App\Utility\LanguageUtility::DOMAIN_DISABLED,
- Mode 2 - example.de =
'process' => \App\Utility\LanguageUtility::LOCALE_URL | \App\Utility\LanguageUtility::DOMAIN_ENABLED,
- Mode 3 - example.com (de-DE session) =
'process' => \App\Utility\LanguageUtility::LOCALE_SESSION | \App\Utility\LanguageUtility::DOMAIN_DISABLED,
(default)
It depends on your configuration what will be returned.
How to create further localisations
- Duplicate one existing file in folder
locale/
(e.g. copyde-DE.php
tofr-FR.php
) - (if you use Mode 1 or 2) Duplicate one existing file in folder
config/routes/
(e.g. copyde-DE.php
tofr-FR.php
) - (if you use Mode 1 or 2) Change route prefix from
/de/
to/fr/
inconfig/routes/fr-FR.php
- You can also define paths like
/fr-be/
(locale/fr-BE.php
/config/routes/fr-BE.php
) for example - If you want to show language in langswitch, add
fr-FR
and domain inlocale => active
(config/additional-settings.php
) - (if you use Mode 1 or 2) Add case for
fr/
insrc/localisation.php
How to switch between different url modes
Mode 1
Example: example.com/de/
- EN is default language and DE is alternative language for this steps
- Got to
locale
inconfig/additional-settings.php
- Set
'process' => \App\Utility\LanguageUtility::LOCALE_URL | \App\Utility\LanguageUtility::DOMAIN_DISABLED,
- Set up english routes with or without
/en
prefix inconfig/routes/en-US.php
- Set up german routes with
/de
prefix inconfig/routes/de-DE.php
config/routes/xx-XX.php
can be leave untouched
Mode 2
Example: de.example.com or example.de
- EN is default language and DE is alternative language for this steps
- Got to
locale
inconfig/additional-settings.php
- Set
'process' => \App\Utility\LanguageUtility::LOCALE_URL | \App\Utility\LanguageUtility::DOMAIN_ENABLED,
- Enter your domains in
active
- Go to
config/routes/de-DE.php
- Remove
/de
prefix from everyroute
- Go to
config/routes/xx-XX.php
- Insert all routes where the config is equal between
config/routes/en-US.php
andconfig/routes/de-DE.php
- Remove these equal routes in
config/routes/en-US.php
andconfig/routes/de-DE.php
Mode 3 (default)
Example: example.com
- EN is default language and DE is alternative language for this steps
- Got to
locale
inconfig/additional-settings.php
- Set
'process' => \App\Utility\LanguageUtility::LOCALE_SESSION | \App\Utility\LanguageUtility::DOMAIN_DISABLED,
- Set up all routes in
config/routes/xx-XX.php
config/routes/en-US.php
can be leave untouchedconfig/routes/de-DE.php
can be leave untouched
ACL settings
With Geggleto ACL, routes are protected by role the current user has. By default every new route is not accessable until you give the route roles.
Routes are defined in the route files (e.g. config/routes/de-DE.php
).
Any other resource is defined in config/settings.php
.
Inside the Twig templates you can use ACL functions has_role
and is_allowed.
Inside controllers you can also use this ACL functions and many more (e.g. isAllowed()
).
Troubleshooting
Error 1
In some cases you'll get the error message "Internal Server Error".
If this happened, go to public/.htaccess
and enable RewriteBase /
.
If project is in sub directory then RewriteBase /project/public/
.
Error 2
Message: is not resolvable File: /var/www/vendor/slim/slim/Slim/CallableResolver.php
If this happened, your Doctrine host in config\additional-settings.php
is wrong.