Page d'accueil>Code source PHP>Autres catégories
Télécharger

Orbiteur satellite 



                       
                     ?️
                   ·          
                · 
     ?️?️️   ·
    ?️?️   ·  ·  · ?️
     ?️?️️

Framework Event & Middleware Facile Facile, alimenté par des micro-bibliothèques populaires et basé sur les PSR.

  • Installation
    • Configurer
  • PSRS implémenté
  • Packages
  • Télécharger la construction
  • Licence

Prend en charge PHP 8.1+ et compositeur

Tl; dr

Jump rapide dans le développement: 

composer create-project orbiter/satellite-app ./satellite

cd ./satellite

# create `.env` file, 
# add for local-dev: `env=local`
touch .env 

# start PHP Dev Server
cd web && php -S localhost:3333 ./index.php display_errors=0

# or point the Apache Root to `/web/`
# or point the NGINX entry to `/web/index.php`
# or use Docker: `docker-compose up`

Ouvrez votre navigateur sur: http: // localhost: 3333

Recherchez les fichiers:

  • dossier config avec configuration d'application et câblage
  • assemble.php Composer Autoload, rassemble des configurations et crée les modules système à partir de cette configuration
  • launch.php runs assemble() et envoie l'événement SatelliteApp
  • dossier app avec des commandes de base et une structure de gestionnaire d'itinéraire

Installation

Installez l'application squelette et dépendances avec compositeur dans le dossier satellite : 

 # with composer installed on machine:
composer create-project orbiter/satellite-app satellite

# with composer and docker on windows:
docker run -it --rm -v %cd%/satellite:/app composer create-project orbiter/satellite-app .
docker run -it --rm -v %cd%/satellite:/app composer create-project --stability=dev orbiter/satellite-app:dev-master .

# with composer and docker on unix:
docker run -it --rm -v ` pwd ` /satellite:/app composer create-project orbiter/satellite-app .
docker run -it --rm -v ` pwd ` /satellite:/app composer create-project --stability=dev orbiter/satellite-app:dev-master .

# go into project folder:
cd ./satellite

Courir avec:

  • Linux, serveur de développement PHP
  • Ligne de commande PHP
  • Docker, docker-compose
  • Serveur Web

Linux, serveur de développement PHP

Configurez les droits des utilisateurs corrects, puis démarrez et ouvrez http: // localhost: 3333 

chmod +x start.sh

./start.sh

Ligne de commande PHP

Exécuter les commandes définies. 

php cli < command > < ..attr > < ..b >

Docker, docker-compose

Comprend un docker PHP configurable avec:

  • PHP 8.1
    • avec FPM et quelques extensions
    • Réutiliser FPM pour une image de travailleur CLI propre
  • Opcache
  • Libs du client postgresql (en utilisant pdo )
  • Image de base Nginx pour le routage local
  • Personnaliser dans Dockerfile
  • Une image plus "de production", préconfigurée pour la construction en CI avec docker-compose - prod.yml

Pour les configurations d'image docker, voir les fichiers dans _docker et _nginx .

Démarrer les conteneurs spécifiés dans docker-compose.yml , puis ouvrir: http: // localhost: 3333 

docker-compose up

# open shell in app container
docker-compose exec app sh

# run command in temporary worker container
docker-compose run --rm worker php cli demo

# run extra composer container on windows:
docker run -it --rm -v %cd%:/app composer dumpautoload
# run extra composer container on unix:
docker run -it --rm -v ` pwd ` :/app composer dumpautoload

# run tests with temporary `app` container:
docker-compose run -T --rm app sh -c " cd /var/www/html && ./vendor/bin/phpunit --testdox tests "

# running tests with a temporary `phpunit` in a prebuild container:
docker run -i --rm bemiteu/satellite-app:master sh -c " cd /var/www && wget -O phpunit https://phar.phpunit.de/phpunit-9.phar && chmod +x phpunit && cd html && /var/www/phpunit --testdox tests "

Serveur Web

Sur un serveur Web, le fichier web/index.php sert de point de saisie public.

Apache: point Point Server / Vhost Root to /web et utilisez le .htaccess inclus

Nginx : exemple de fichiers dans _nginx.

Configurer

Utilisez par exemple .env pour ajouter une configuration.

La configuration par défaut comprend:

  • Env var env : Si en production ou non en production
    • Avec la valeur prod il est supposé dans l'application (pas le cadre) qu'il est en production
    • Utilisez $_ENV['env'] === 'prod' pour vérifier la production
    • Pour les pages de dev-error: ajoutez var dev.editor avec une valeur de PrettyPageHandler::EDITOR_* pour lier whoops "ouvrir le fichier" avec ide
  • /config/config.php - configuration principale
    • configure quels autres fichiers de configuration sont inclus
    • regroupe et cache la configuration pour l'utilisation de la production
  • /config/dependencies.php - Définitions de php-di
  • /config/events.php - Définir le flux des composants de l'application
  • /config/pipeline.php - Configuration de PSR Middlewares et Pipeline

PSR

Cette application sert de mini-travail, avec des bibliothèques alimentées par PSR, des annotations prêtes à l'emploi et pas beaucoup plus.

Il s'appuie sur les PSR et les packages populaires et spécialisés les mettant en œuvre ou d'autres superbes choses.

  • PSR-3 - Enregistreur
    • ? monolog/monolog
    • Plus d'implémentations
  • PSR-4 - Classes Autoload et oubliez require_once
    • Géré par le compositeur, plus dans les documents compositeurs.
  • PSR-1,12 - Guides de style de code
    • sauf la règle de localisation des supports: la même ligne au lieu de la ligne suivante pour l'ouverture {
  • PSR-6 - Cache
    • ? cache/filesystem-adapter
    • Comprend FilesystemCachePoolNormalized pour DoctrineCommonAnnotationsPsrCachedReader Compatibilité
    • Plus d'implémentations
  • Message PSR-7 - HTTP
    • ? nyholmpsr7
    • Définitions des données de demande et de réponse
    • utilisé plus loin par PSR-15 , PSR-17 et PSR-18
  • PSR-11 - conteneur pour interopération
    • ? php-di/php-di
    • Conteneur de service pour la facilité et la modularité
    • Injection de dépendance avec @Annotations , @var phpdoc et support de réflexion
  • PSR-14 - Dispatcher d'événements et auditeur
    • ? orbiter/satellite
    • comme le cœur de la façon dont les choses sont assemblées
  • PSR-15 - HTTP Handlers
    • ? orbiter/satellite-response
    • gérer les demandes d'itinéraire avec un puissant pipeline de middleware
  • PSR-16 - Cache simple
    • ? cache/filesystem-adapter
    • Plus d'implémentations
  • PSR-17 - Usines HTTP
    • ? nyholmpsr7
    • contexte de la demande
    • Pour les initiations de demande et de réponse
  • PSR-18 - Client HTTP
    • ? guzzlehttp/guzzle
    • Envoyer des demandes à d'autres API
    • Plus d'implémentations

? = inclus dans le modèle satellite-app

Packages

  • orbiter/satellite
    • implémente le répartiteur d'événements PSR-14 et l'auditeur
    • avec invocateur pour exécuter quoi que ce soit, PSR-11 compatible
    • profilage basé sur un événement en option
    • voir le référentiel de packages
  • orbiter/satellite-console
    • exécution de la console
    • Annotations de commandement de la console
    • utilise getOPT-Php
    • voir le référentiel de packages
  • orbiter/satellite-response
    • Exécution de tuyaux au middleware
    • implémente PSR-15 via equip/dispatch , conforme au PSR-11
    • implémente PSR-7,17 via nyholm/psr7 et nyholm/psr7-server
    • avec un émetteur simple par narrowspark/http-emitter
    • voir le référentiel de packages
  • orbiter/satellite-route
    • itinéraires par annotations
    • Utilise Nikic / Fast Route comme routeur
    • Fabriqué pour l'utilisation du middleware PSR, mais sans limité
    • voir le référentiel de packages
  • orbiter/annotations-util
    • Annotations par doctrine/annotations avec réflexions mises en cache
    • Obtenez des cours, des méthodes et des propriétés qui sont annotées
    • Voir AnnotationsUtil
  • orbiter/satellite-whoops
    • Affichage d'erreur de whoops pour la CLI et les itinéraires
    • uniquement lorsque $_ENV['env'] pas prod (configurable dans assemble.php )
  • orbiter/satellite-config
    • agrégateur de configuration simple avec mise en cache
    • voir le référentiel de packages
  • orbiter/satellite-launch
    • Objets de données d'événement SatelliteApp
    • voir le référentiel de packages
  • orbiter/satellite-system
    • Configuration du système et câble de base, par exemple de $config à un conteneur PSR mis en cache
    • voir le référentiel de packages

Beaucoup de travail pour les API est effectué par le middleware HTTP PSR-15, trouvez plus de middlewares impressionnants.

Télécharger la construction

Il n'y a pas de version téléchargeable - voir Configuration sur la façon d'installer avec Composer.

Nous utilisons Composer comme gestionnaire de packages, comme dans tout projet PHP moderne.

N'hésitez pas à tendre la main pour une demande de formation.

Licence

Ce projet est un logiciel gratuit distribué sous la licence MIT .

Contributeurs

En engageant votre code dans le référentiel de code, vous acceptez de libérer le code sous la licence MIT attachée au référentiel.

Maintenu par Michael Becker

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout