umvc
1.0.0
Version 2.0.2 -- 2024-12-13
A simple web-application framework implementing model-view-controller (MVC) architectural pattern.
composer require "simplesamlphp/simplesamlphp:^2.2")UMVC supports modules, see configuration/components.
The framework supports functional testing with its framework plugin. Globally installed codeception must be compatible with required (currently v3.1.2)
UMVC supports CLI. You may create your own commands. The built-in commands are:
Run commands as php app $command $action $parameters
The framework can be included into your project with composer. Run composer require uhi67/umvc:dev-master.
New, empty project can be created using composer create-project --prefer-dist uhi67/umvc-app name. This will deliver you a new empty application using UMVC framework into the named directory. Choose any name you prefer.
Warning: This part is under construction. Learn more about the mentioned classes in the docblock of the class definition.
composer.json of your application, and include uh67/umvc, e.g composer init --name myname/myapp --require uhi67/umvc:*.composer update.vendor/uh67/umvc/app to your application's root. This is the launcher of the CLI commands.vendor/uh67/umvc/www/index.php and .htaccess to your application's www directory. This is the router of the web interface.config/config.php file, see template in vendor/uh67/umvc/config/config-template.php.runtime directory writable by the webserver to place temporary files.www/assets directory writable by the webserver to place cached asset files of various components.controllers dir, using appcontrollers namespace, and derive them from uhi67umvcController.views dir, in simple PHTML format, and organize them according to views/controller/action.php structure.models directory. Database models are uhi67umvcModel, database-less models are uhi67umvcBaseModel.migrations directory.views/layouts directory. Views can call other partial views.commands directory, deriving from uhi67umvcCommand class. There are some built-in command in the framework. php app command lists all available commands, both built-in and custom ones.messges/la.php files where "la" is the language you want to translate to.All components,most of UMVC classes, including the main App class itself, is a uhi67umvcComponent.
Component implements property features: magic getter and setter uses getProperty and setProperty methods.
Component is configurable: constructor accepts a configuration array containing values for public properties.
MySqlConnection -- to connect to database. Includes SQL query builder. Currently the only implementation of Connection.FileCache -- the only implementation of CacheInterface.SamlAuth -- the only implementation for AuthManager.L10n -- simple localization, default auto-included, translates UMVC messages only.L10nFile -- the file-based localization to translate messages of your application.Form -- a widget with built-in view to display and process HTML forms using your Models.Grid (widget, but the built-in view is still missing) -- to display paginated, filtered lists of Models.Query -- Represents a parametrized and flexible SQL query in php structure. SQL command can be built from it.Request -- Represents the HTTP request, can be used to fetch GET and POST parameters.Session -- Represents the current PHP session, can be used to get and set variables.The single entry script for the web application is the www/index.php.
Respectively, the single entry script for the CLI application is the app file.
Both of them must be copied into your application directory from the vendor/uhi67/umvc/ directory.
The www/.htaccess rules redirect all not-found requests to the www/index.php.
However, static assets are served directly from the www directory. Learn more about serving library assets later.
The index.php initializes the autoloader, load the main configuration, creates the main object
(class defined in the configuration, usually uhi67/umvc/App or its descendant).
The main configuration follows the rules of the configurable Component.
All URL formed as https://myapp/acontroller/anaction is processed the following way:
uhi67/umvc/App parses the request, computes the actual controller class (derived from uhi67/umvc/Controller) to use,
creates the controller and runs the requested action method. As in the example above, acontroller refers to your controller
class in your controllers directory as AcontrollerController, and anaction refers to the action method (as actionAnaction).
If the action name is missing from the URL, the actionDefault will be run. If the controller name is missing as well,
the configured mainController will be used. It is also possible to create a URL with an action name of the
default controller without specifying the controller name - the only restriction you cannot have a controller with the same name as this action.
Al CLI command formed as php app acontroller/anaction is processed the following way:
uhi67/umvc/App parses the request, computes the actual controller class (derived from uhi67/umvc/Command) to use,
creates the controller and runs the requested action method. As in the example above, acontroller refers to your controller
class in your commands directory as AcontrollerController, and anaction refers to the action method (as actionAnaction).
Built-in commands can be run the same way. A command with the same name in our application overrides the built-in command.
The parts of the current URL request can be accessed as:
To create a new URL using controller and action names, and optioanl qurey parameters, use one of the following:
In your view files, you can refer your static assets located under www directory in static way, e.g <link href="/assets/css/app.css" rel="stylesheet">.
On the contrary, if you want to refer to an asset file located somewhere in the composer-created vendor library, you can use them this way:
<script src="<?= $this->linkAssetFile('npm-asset/bootstrap/dist', 'js/bootstrap.bundle.min.js') ?>"></script>The linkAssetFile function copies all the files from the directory in the first argument into the asset
cache directory under the www , and creates a valid URL to the file int the second argument.
Note: The first argument identifias an asset package. Only the first call for any package copies the files.
All subsequent calls to the same package generates only the link for the file.
The asset cache is emptied by the composer install command.
The asset cache is always www/asset/cache and is not configurable.
...
This repository contains a built-in test application for internal codeception unit tests.
The only purpose of the test app in the tests directory is to be able to run unit tests, and not a sample application to start with.
git clonecomposer updatetests/_data/test-config.php based on the templateumvc-test database according to the database settings in tests/_data/test-config.phpphp vendor/bin/codecept run unit for unit testsMore unit tests are coming...
A built-in dockerized testing environment can be used to test with different php and database versions.
Steps:
tests/docker-compose.yml (make clones of this template file)tests/docker/Dockerfile (extension installation steps may change)tests/.envdocker compose up --build -d (in the tests dir)docker exec -it umvc-php-1 php vendor/bin/codecept run unit
