Jump to content

Symprowire - PHP MVC Framework for ProcessWire 3.x // v0.6.0-rc1


Recommended Posts

Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider

It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.

The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.

You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire

Documentation

Last Update

Requirements

  • PHP ^7.4
  • Fresh ProcessWire ^3.0.181 with a Blank Profile
  • Composer 2 (v1 should work, not recommended)
  • The usual Symfony Requirements

Features

  • Twig
  • Dependency Injection
  • Monolog for Symprowire
  • Support for .env
  • YAML Configuration
  • Symfony Console and Console Commands
  • Symfony Webprofiler
  • Full ProcessWire access inside your Controller and Services
  • Webpack Encore support

Caveats

Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

Screenshot_2.thumb.jpg.e10951ef6fa51650b28349018601967d.jpgScreenshot_3.thumb.jpg.d44499e5b10ede41c363ee171c2285a1.jpgScreenshot_4.thumb.jpg.f1b0cb9bcb17e07d8179ec52c6ebe049.jpg

So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env

 

Edited by LuisM
new Release
  • Like 6
Link to comment
Share on other sites

@netcarver oh wow thanks for the Larawire mention. Didnt knew there where similar attempts but with Laravel.

Anyways, I have a slow day in the office and wanted to clean up a bit. So meet PoC v.0.1.0. I completly encapsulated Symfony now to dont mess with ProcessWires file/directory structure and keep things clean. 
I think, this should be a good base to develop this thing further. Am happy 🙂

  • Like 1
Link to comment
Share on other sites

I just finished to clean up the repo and pushed Symprowire as stand-alone module to GIT. 

I marked the commit as RC-1 

The Framework should work right now like every other Symfony App handling wise, with the exception of twig templates bound to the processwire directory structure.
Next would be to integrate ProcessWire Services like logger, input et all as Symfony Services and autowire them into the Controller.

Stay tuned, oh and feel free to comment 🙂

  • Like 2
Link to comment
Share on other sites

  • LuisM changed the title to Symprowire - MVC Framework // v0.2.0-rc1

Release RC1 v0.2.0 -> https://github.com/Luis85/symprowire/releases/tag/v0.2.0-rc-1

  • added Session Handshake to integrate PW Session into Symfony
  • added $page, $pages, $input, $session, $modules, $users as member to AbstractController 
  • added Symprowire autowire Services outside of userland into /lib/src and added own Namespace for the lib
  • added Repositories (Pages, Modules, User) to the lib
  • added UserRepository to HomeController::index() as Dependency Injection for Demonstration / as Example
  • Like 2
Link to comment
Share on other sites

Looking forward to your experience @netcarver 🙂

What I actually dont like at all right now is how I hand over the Request handling.

My idea is, to use ProcessWire as a DBAL and load Pages via a Repository to centralize modification, loading of PageData and use the Admin to create a Structure, Content and handle Templates and let Symprowire use Entities as simple DTO to reflect ProcessWire Templates.

I think this will open up a clear Migrations path later on and will make Form creation easy with the symfony/forms component.

Right now I add a replace hook on TemplateFile render() and the used frontcontroller template will allow UrlSegments to be set.

I must admit, Routing is not something I have invested much tought into yet. Maybe you guys have some ideas what could work best here 

@teppo

@bernhard

@netcarver

Link to comment
Share on other sites

26 minutes ago, bernhard said:

I've never used symfony (only the CLI component) so I have to admit that I don't understand what you are doing here, sorry 😉 

Oh hahaha, my question is more about, what would be the best method/hook to intercept ProcessWire rendering or routing to replace the Response completly.

Link to comment
Share on other sites

Release v0.3.0-rc1

- added Webpack Encore Support
- removed Symprowire Autload condition. Symprowire is now configured to server every request except admin
- implemented recommended template structure into lib/twig 
- added more context and information to the HomeController
- added $user and $session as Global Twig Variable // both as ProcessWire Objects
- implemented example Webpack Encore Application using stimulus.js served by lib/twig

Link to comment
Share on other sites

  • LuisM changed the title to Symprowire - PHP MVC Framework for ProcessWire 3.x // v0.4.0-rc1

Working Full-Time on the Module for this week after getting it running its just good old Symfony Development to make the Glue hold tight on ProcessWire. 
I plan to build a Blog with Symprowire next to see if everything works as expected. 

I added a small Project over at Github to keep you informed. Will continue to post release notes. For now, I edited the 1st Post as this would be my Base to develop the Blog.

  • Like 1
Link to comment
Share on other sites

On 7/13/2021 at 4:23 PM, LuisM said:

Right now I add a replace hook on TemplateFile render() and the used frontcontroller template will allow UrlSegments to be set.

I must admit, Routing is not something I have invested much tought into yet. Maybe you guys have some ideas what could work best here 

I can't say that I have a strong opinion here either. Also not sure if I grasp the whole context — when you say "routing" and mention URL segments, does that mean that you create routes automatically based on page structure (I assume so but...) or that there's a separate routing setup for front-end and page structure is only reflected in the data? Or do you mean something different with this? 🙂

This may or may not be related, but one thing to consider is whether you want Symprowire to be "all in", or rather something that can be used only for some parts of the site. Couple of examples from other MVC(ish) solutions:

  • Template Engine Factory hooks before Page::render and replaces the response, but also provides hookable method (TemplateEngineFactory::shouldRenderPage) for preventing it from rendering the page, in which case the site will fall back to the regular rendering flow (whatever that happens to be).
  • Wireframe takes an entirely different approach: instead of a hook ("enabled by default") you need to point templates that you want to render via it to the front controller file via Alternate Template Filename setting (more details in the docs). Essentially it's disabled by default.

Wireframe is my pet project and something we've used for our production sites for a while now, so that's what I'm mostly familiar with. I intentionally decided not to use hooks, since I felt it was best to let the developer decide if they want to use Wireframe for everything, just a small part of the site, or something in between. In fact it's possible to skip the MVC structure entirely, and just use Wireframe for its partials and/or components 🤷‍♂️

Template Engine Factory may be a bit closer to Symprowire feature wise, although Symprowire clearly has a much larger scope (and is more opinionated). So not sure if any of what I've said here applies as-is 🙂

  • Like 3
  • Thanks 1
Link to comment
Share on other sites

Thank you Teppo for that detailed answer. Really appriciate it. 

1 hour ago, teppo said:

I can't say that I have a strong opinion here either. Also not sure if I grasp the whole context — when you say "routing" and mention URL segments, does that mean that you create routes automatically based on page structure (I assume so but...) or that there's a separate routing setup for front-end and page structure is only reflected in the data? Or do you mean something different with this? 🙂

My first take was similiar to Wireframe. Adding a Template as alternate Template file and replace the render accordingly. But it didnt felt quite right, taking the tools Symfony provides into consideration. I now let Symprowire act as a drop-in solution to replace ProcessWire rendering completly. 

What this basically means is, ProcessWire will no longer be in charge about anything URL or rendering related. 
As of now Symprowire will intercept the Request and manage routing decoupled from ProcessWire. So ProcessWire will step back and act as a Data/Service Provider for Symprowire.

What I actually did here is separating into more or less 3 layers. 

  • ProcessWire as Data and Server Provider 
  • Symprowire as Businesslogic Backend MVC style powered by a Symfony Architecture
  • a separated Frontendlayer served by Twig Templates

ProcessWire Admin will be used as Data Editor / Content Management System and Symprowire will consume this data and do stuff with it before handing over to Twig.this

1 hour ago, teppo said:

... or that there's a separate routing setup for front-end and page structure is only reflected in the data ...

This would describe it best I guess.

 

1 hour ago, teppo said:

Wireframe is my pet project and something we've used for our production sites for a while now, so that's what I'm mostly familiar with.

I actually use Wireframe as Output Framework in the Project im working on 🙂

Quote

 I intentionally decided not to use hooks, since I felt it was best to let the developer decide if they want to use Wireframe for everything, just a small part of the site, or something in between. In fact it's possible to skip the MVC structure entirely, and just use Wireframe for its partials and/or components 🤷‍♂️

I am still not sure if this should be a possibility or an option in Symprowire. Its tempting to let the Developer decide, but on the other hand I mainly create Symprowire to give a somewhat strict structure and to have Phpunit tests in the not so far future. Which would be hard to integrate if just parts could be tested. Decisions decision decision... 😕 

 Another reason I am into this is the clear and concise way Symfony handles the Request/Response, it just makes so much sense for me to combine this both worlds. Take the very very strong parts CMS/CMF wise from ProcessWire and combine it with Symfony. I dunno 🙂 just feels to be like this 

 

1 hour ago, teppo said:

Template Engine Factory may be a bit closer to Symprowire feature wise, although Symprowire clearly has a much larger scope (and is more opinionated). So not sure if any of what I've said here applies as-is 🙂

Dont worry, I knew you would give great insights the moment I tagged you 😄 
Have to dig into TemplateEngineFacotry code now 😉

 

 

  • Like 1
Link to comment
Share on other sites

  • LuisM changed the title to Symprowire - PHP MVC Framework for ProcessWire 3.x // v0.5.0-rc1

Bump up to v0.5.0 

I added a tutorial for a simple Symprowire Blog Application.
You can find the tutorial here: https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial

To keep up with development and organize the project I added a GitHub Project and corresponding Issue Management. You can find it here: https://github.com/Luis85/symprowire/projects/1

  • Like 1
Link to comment
Share on other sites

  • LuisM changed the title to Symprowire - PHP MVC Framework for ProcessWire 3.x // v0.6.0-rc1

Bump up to v0.6.0

Breaking Changes

  • renamed AbstractRepository to AbstractPagesRepository
  • added new ProcessWireService / ProcessWireServiceInterface as wrapper to access ProcessWire in a centralized way and to reduce wire() function calls.
  • replaced all wire() function calls with using ProcessWireService
  • Like 1
Link to comment
Share on other sites

  • 2 months later...

@LuisM This is really sweet. ProcessWire is awesome but for bigger projects, that go beyond a simple website, managing business logic and templates can get messy really quickly. I really like your attempt on integration with Symfony. I thought about a couple experiments to "professionalize" ProcessWire development too, e.g.

  • having the PW core and PW admin be independent packages
  • being able to load these packages through composer
  • having proper namespacing with autoloading
  • being able to use bundles for easier separation of business logic
  • going headless first (PW is so close to being there although not focusing on it at all)

 

One question: How would you manage to stay compatible with future PW version? Would that be possible without additional work in the future?

Link to comment
Share on other sites

  • 3 weeks later...

@MrSnoozles thanks for your kind words.

Yeah my main intent is to handle ProcessWire in a sane way with current "best-practices" in PHP Userland.

Which includes things like

  • Composer all the way
  • Dependency Injection 
  • Migrations!!!
  • Separation of concerns (hello Twig for example)
  • proper Headless Content distribution
On 9/28/2021 at 3:53 PM, MrSnoozles said:
  • having the PW core and PW admin be independent packages
  • being able to load these packages through composer
  • having proper namespacing with autoloading
  • being able to use bundles for easier separation of business logic
  • going headless first (PW is so close to being there although not focusing on it at all)

Nice, I had the exact same thoughts so far 🙂

I really like ProcessWire and it is my first go to whenever I need a MVP or an Prototype. But in the long run, or whenever I have more than 1 Developer working on the code the nightmare begins, atleast for me.

On 9/28/2021 at 3:53 PM, MrSnoozles said:

One question: How would you manage to stay compatible with future PW version? Would that be possible without additional work in the future?

I really dont know 🙂

The main problem is the way ProcessWire is organized, as it was never intended to be used as Dependency in another Project. So yeah, right now, whenever @ryan is in production mode and pushes new Versions I have to manually update the codebase. 

The thing is, I started to develop Symprowire because I had a Prototype in ProcessWire which acted as a Proof of Concept for some client presentations. To develop the concept and bring it to production ProcessWire just wasnt enough, I learned it the hard way 🙂 *cough* migrations *cough cough*

So in the course of 1 1/2 year I ported the PoC to Laravel with the intent to use Laravel Spark as our Product is a SaaS with fully fledged Multi-tenancy. Unfortunatly Laravel Spark wasnt that good of a solution back in the days as it was too opinionated and the general direction Laravel as a Framework is developed... mhhh I would say is not my cup of tea. 

So I started to port over to Symfony as we worked with Symfony some years ago to develop a Marketplace supporting 72 Languages and had ~ 350 active sellers from the beginning. I would say it was a fairly big project and I felt confident to work with the Framework, but I missed ProcessWire's CMS/CMF possibilites which ultimatly brings us to Symprowire.

As of today, we ditched ProcessWire completly from our Product and went full ham with Symfony as we are using

  • symfony/notifier for async notifications 
  • symfony/messenger for RabbitMQ 
  • api platform for our headless needs
  • and all the bits and pieces symfony brings

To give you an idea, I just published a basic Fullstack Template covering all our needs. You can find it here: https://github.com/Luis85/symfony-full-skeleton

Right now, I really dont know how to develop Symprowire or in which direction I would like to go with the Project. 
I have a lot of Ideas but every idea would be a complete refactor. I thought something like, yeah just copy the Data Modell ProcessWire uses and port it to Symfony to make a new CMS based on Symfony with the spirit of ProcessWire. I really dont know right now 🙂 What I know is, I want to contribute to ProcessWire.

 

  • Like 1
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   1 member

  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...