https://github.com/thecodingmachine/integration.wordpress.moufpress
A MVC framework for Wordpress based on Mouf and compatible with Splash MVC
https://github.com/thecodingmachine/integration.wordpress.moufpress
Last synced: 3 months ago
JSON representation
A MVC framework for Wordpress based on Mouf and compatible with Splash MVC
- Host: GitHub
- URL: https://github.com/thecodingmachine/integration.wordpress.moufpress
- Owner: thecodingmachine
- License: mit
- Created: 2014-03-14T11:09:20.000Z (over 12 years ago)
- Default Branch: 3.0
- Last Pushed: 2015-11-18T16:03:54.000Z (over 10 years ago)
- Last Synced: 2025-02-16T12:30:28.405Z (over 1 year ago)
- Language: PHP
- Size: 258 KB
- Stars: 0
- Watchers: 14
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
MoufPress: a MVC framework for Wordpress based on Mouf
======================================================
Why should I care?
------------------
Moufpress is a **MVC framework for Wordpress**. Actually, it is a bridge between [Wordpress](http://wordpress.org/) and
the [Splash MVC framework](http://mouf-php.com/packages/mouf/mvc.splash/index.md)
used by [Mouf-PHP](http://mouf-php.com) (a dependency injection based framework).
MoufPress offers the following features:
- **compatible controllers**, declared through a nice graphical DI container
- **PSR-7 compatibility**: your controllers can take into parameter `Request` objects and respond `Response` objects
that are compatible with the [PSR-7 HTTP Message interfaces](http://www.php-fig.org/psr/psr-7/).
- use of **annotations** in your controllers (for instance: `@URL` to declare a new route, `@Logged` to restrict access to logged users, etc...)
- support for any kind of **views** supported in Splash MVC (this includes plain PHP files, [Twig templates](http://twig.sensiolabs.org/), etc...)
- a [nice web-based UI to scafold your controllers and views](http://mouf-php.com/packages/mouf/mvc.splash/doc/writing_controllers.md)
- integration of your views inside the Wordpress theme
- (very) easy Ajax support
- creating [**Wordpress widgets**](doc/widgets.md) through dependency injection in Mouf
- integration of Mouf's [**authentication and authorization**](doc/authentication_and_right_management.md) system into Wordpress
- integration of Mouf's [**web library (JS/CSS)**](doc/scripts-and-styles.md) system into Wordpress
Another interesting feature is that your code is **100% compatible** with Splash MVC. This means that:
- You can write a controller in Splash MVC and deploy it later in Wordpress (or the opposite)
- Since there is also a Drupal module for Splash ([Druplash](http://mouf-php.com/packages/mouf/integration.drupal.druplash/README.md)),
you can actually **write a controller in Wordpress and deploy it in Drupal** (or the other way around).
Yes, you read it correctly, you can develop an application that will run on both Wordpress and Drupal (!)
Haha! I see you're interested. Let's get started!
Installation
------------
You will first need to install Wordpress and Mouf side by side.
1. Start by installing [Wordpress](http://wordpress.org/) as you would normally do.
2. Install the [WP-Router plugin](https://wordpress.org/plugins/wp-router/).
Note: even if the plugin page stats this plugin works up to version 3.4 of Wordpress,
we have tested with Wordpress 3.8.1 and 4.3.1 and it works great.
3. [Install the Mouf PHP framework](http://mouf-php.com/packages/mouf/mouf/doc/installing_mouf.md) _in the same directory_ as Wordpress
This means you should have the **composer.json** file of Composer in the same directory as the **wp-config.php** of Wordpress.
4. Modify **composer.json** and add the **moufpress** module. Your **composer.json** should contain at least these lines:
{
"autoload" : {
"psr-4" : {
"MyApp\\" : "src/MyApp"
}
},
"require" : {
"mouf/mouf" : "~2.0",
"mouf/integration.wordpress.moufpress" : "~3.0"
},
"minimum-stability" : "dev",
"prefer-stable": true
}
Do not forget to customize your vendor name (the `MyApp` part of the autoloader section).
5. Create the empty `src/` directory at the root of your project.
6. Run the install process in Mouf: connect to Mouf UI and run the install process for all the packages
(including Moufpress install process of course)
7. If it has not been done already, activate the **WP Router** module, as well as URL rewriting in settings >> permalinks menu (the only option that CANNOT be set is the default one : `http://localhost/wordtest/?p=123`).
8. When you downloaded Moufpress, Composer automatically copied a Moufpress plugin in the `wp-content/plugins` directory of
Wordpress. You need to install this plugin. Connect to your Wordpress admin, select the **Plugins > Installed plugins**
menu, and click on the "Activate" button for the "Moufpress" plugin.
Getting started
---------------
[In the next section, we will learn **how to create a controller and a view**.](doc/mvc.md)
Or if you already know Splash, you can directly jump to another part of this documentation:
- [widgets integration](doc/widgets.md)
- [authentication and authorization](doc/authentication_and_right_management.md)
- [web library (JS/CSS)](doc/scripts-and-styles.md)