PrestaShop / PrestaShop/docs

Document the flow of a Front Controller and a BackOffice Controller ?

Open
#674 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Scala
Stars
136
Forks
555
Avg merge
4d 14h
Merged PRs (30d)
4

Description

I'm considering the idea of describing what happens behind the curtains when a HTTP request hits PrestaShop.

So I would describe

  • how request is matched against an URL and dispatched
  • how Controller is located and loaded
  • the Controller different steps (init, bootstrap, layout ...)
  • how Smarty templates are loaded and rendered

The main goal behind that is to help answer the following question: "As a module developer, I want to modify the Smarty template for AdminXXXController, where can I find it ? how is it loaded ?"

I want to highlight the different kind of files a developer must expect to modify when working on a FO page or a BO page. "My template will go there, my controller will go there, if I need a service I'll put it there ..."

wdyt @PrestaShop/prestashop-core-developers ?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the HTTP request through URL matching and dispatch, controller loading, controller lifecycle steps, and Smarty template rendering. The documentation should explain where module developers find Front Office and Back Office templates, controllers, and services, and how those templates are loaded. The issue names no specific files or tests, so the relevant entry points must first be located.

Written by the indexing model from the issue text.

Assessment

Domain
backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.