Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Establish a main "PHP architecture" chapter #5242

Merged
merged 2 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions Documentation/CodingGuidelines/CodingBestPractices/Index.rst

This file was deleted.

2 changes: 0 additions & 2 deletions Documentation/CodingGuidelines/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ should be sufficient.
:titlesonly:

Introduction
PhpArchitecture/Index
CglPhp/Index
CodingBestPractices/Index
CglJavaScript/Index
CglTypeScript/Index
CglTypoScript/Index
Expand Down
34 changes: 0 additions & 34 deletions Documentation/CodingGuidelines/PhpArchitecture/Index.rst

This file was deleted.

6 changes: 6 additions & 0 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ TYPO3 Explained
Learn how to write site packages and other custom extension with or
without Extbase.

.. card:: :ref:`PHP architecture <cgl-php-architecture>`

General PHP architectural strategies in TYPO3 core development and best
practices for extension developers.

.. card:: :ref:`Security guidelines <security>`

This chapter describes some typical risks and advises how to protect a
Expand All @@ -60,6 +65,7 @@ TYPO3 Explained
Configuration/Index
CodingGuidelines/Index
ExtensionArchitecture/Index
PhpArchitecture/Index
Security/Index
Testing/Index

Expand Down
29 changes: 29 additions & 0 deletions Documentation/PhpArchitecture/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. include:: /Includes.rst.txt

.. _cgl-modeling-cross-cutting-concerns:
.. _cgl-php-architecture:
.. _cgl-best-practices:

================
PHP architecture
================

Writing excellent PHP code within the TYPO3 framework involves more than just correctly
utilizing the framework's API: It also requires making sound decisions regarding general
PHP architecture.

This chapter addresses general PHP architectural considerations and best
practices, with a focus on TYPO3. It covers both overarching principles of
good PHP architecture relevant to TYPO3 Core developers and best practices
specifically for extension developers.

.. toctree::
:maxdepth: 1
:titlesonly:

NamedArguments
Services
StaticMethods
Traits
WorkingWithExceptions
Singletons
Loading