forked from GNUsocial/gnu-social
[DOCS][Developer] Adopt a top-down approach
Minor corrections to the overview
This commit is contained in:
parent
086754d95b
commit
4ef400f509
@ -1,6 +1,5 @@
|
|||||||
# Summary
|
# Summary
|
||||||
|
|
||||||
- [High level view](./high_level.md)
|
|
||||||
- [Architecture: Modules](./architecture.md)
|
- [Architecture: Modules](./architecture.md)
|
||||||
- [Programming Style](./paradigms.md)
|
- [Programming Style](./paradigms.md)
|
||||||
- [Events](./events.md)
|
- [Events](./events.md)
|
||||||
@ -17,7 +16,21 @@
|
|||||||
- [Plugins](./plugins.md)
|
- [Plugins](./plugins.md)
|
||||||
- [Configuration](./plugins/configuration.md)
|
- [Configuration](./plugins/configuration.md)
|
||||||
- [Initialization and Clean Up](./plugins/lifetime.md)
|
- [Initialization and Clean Up](./plugins/lifetime.md)
|
||||||
|
- [Debugging](./debugging.md)
|
||||||
- [Sample Plugins](./sample_plugins.md)
|
- [Sample Plugins](./sample_plugins.md)
|
||||||
- [Injecting Javascript](plugins/sample_plugins/Awesomeness.md)
|
- [Injecting Javascript](plugins/sample_plugins/Awesomeness.md)
|
||||||
- [Creating a block on the sidebar](plugins/sample_plugins/Sample.md)
|
- [Creating a block on the sidebar](plugins/sample_plugins/Sample.md)
|
||||||
- [Components](./components.md)
|
- [Components](./components.md)
|
||||||
|
- [Core](./core.md)
|
||||||
|
- [Overview](./core/overview.md)
|
||||||
|
- [Modules](./core/modules.md)
|
||||||
|
- [Event dispatcher](./core/event-dispatcher.md)
|
||||||
|
- [ORM and Caching](./core/orm_and_caching.md)
|
||||||
|
- [Interfaces](./core/interfaces.md)
|
||||||
|
- [UI](./core/ui.md)
|
||||||
|
- [Internationalization](./core/internationalization.md)
|
||||||
|
- [Utils](./core/util.md)
|
||||||
|
- [Queues](./core/queues.md)
|
||||||
|
- [Files](./core/files.md)
|
||||||
|
- [Security](./core/security.md)
|
||||||
|
- [HTTP Client](./core/http.md)
|
18
docs/developer/src/core.md
Normal file
18
docs/developer/src/core.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
# The Core
|
||||||
|
This documentation adopted a top-down approach. We believed this to be the most helpful as it reduces the time needed
|
||||||
|
to start developing third party plugins. To contribute to GNU social's core, on the other hand, it's important to
|
||||||
|
[understand its flows](./core.md) and internals well.
|
||||||
|
|
||||||
|
The `core` tries to be minimal. The essence of it being various wrappers around Symfony. It is divided in:
|
||||||
|
|
||||||
|
- [Modules](./core/modules.md);
|
||||||
|
- [Event dispatcher](./core/event-dispatcher.md);
|
||||||
|
- [ORM and Caching](./core/orm_and_caching.md);
|
||||||
|
- [Interfaces](./core/interfaces.md);
|
||||||
|
- [UI](./core/ui.md);
|
||||||
|
- [Internationalization](./core/internationalization.md);
|
||||||
|
- [Utils](./core/util.md);
|
||||||
|
- [Queues](./core/queues.md);
|
||||||
|
- [Files](./core/files.md);
|
||||||
|
- [Security](./core/security.md);
|
||||||
|
- [HTTP Client](./core/http.md).
|
0
docs/developer/src/core/event-dispatcher.md
Normal file
0
docs/developer/src/core/event-dispatcher.md
Normal file
0
docs/developer/src/core/files.md
Normal file
0
docs/developer/src/core/files.md
Normal file
0
docs/developer/src/core/http.md
Normal file
0
docs/developer/src/core/http.md
Normal file
0
docs/developer/src/core/interfaces.md
Normal file
0
docs/developer/src/core/interfaces.md
Normal file
0
docs/developer/src/core/internationalization.md
Normal file
0
docs/developer/src/core/internationalization.md
Normal file
0
docs/developer/src/core/modules.md
Normal file
0
docs/developer/src/core/modules.md
Normal file
0
docs/developer/src/core/orm_and_caching.md
Normal file
0
docs/developer/src/core/orm_and_caching.md
Normal file
@ -1,4 +1,4 @@
|
|||||||
# GNU social at a high level
|
# Overview of GNU social's Core Internals
|
||||||
|
|
||||||
GNU social's execution begins at `public/index.php`, which gets
|
GNU social's execution begins at `public/index.php`, which gets
|
||||||
called by the webserver for all requests. This is handled by the
|
called by the webserver for all requests. This is handled by the
|
||||||
@ -30,7 +30,7 @@ The latter, is launched when the `bin/console` script is used.
|
|||||||
|
|
||||||
In both cases, these events call the `register` function, which
|
In both cases, these events call the `register` function, which
|
||||||
creates static references for the services such as logging, event and
|
creates static references for the services such as logging, event and
|
||||||
translation. This is done so these services can be used via static
|
translation. This is done, so these services can be used via static
|
||||||
function calls, which is much less verbose and more accessible than
|
function calls, which is much less verbose and more accessible than
|
||||||
the way the framework recommends. This function also loads all the
|
the way the framework recommends. This function also loads all the
|
||||||
Components and Plugins, which like in V2, are modules that aren't
|
Components and Plugins, which like in V2, are modules that aren't
|
||||||
@ -51,7 +51,7 @@ as in V2, where each 'Entity' has a `schemaDef` static function which
|
|||||||
returns an array with the database definition. The latter handles the
|
returns an array with the database definition. The latter handles the
|
||||||
loading of modules (components and plugins).
|
loading of modules (components and plugins).
|
||||||
|
|
||||||
This datbase definition is handled by the `SchemaDefPass` class, which
|
This database definition is handled by the `SchemaDefPass` class, which
|
||||||
extends `Doctrine\Persistence\Mapping\Driver\StaticPHPDriver`. The
|
extends `Doctrine\Persistence\Mapping\Driver\StaticPHPDriver`. The
|
||||||
function `loadMetadataForClass` is called by the Symfony
|
function `loadMetadataForClass` is called by the Symfony
|
||||||
framework for each file in `src/Entity/`. It allows us to call the
|
framework for each file in `src/Entity/`. It allows us to call the
|
||||||
@ -62,17 +62,17 @@ to load the entity definitions from each plugin.
|
|||||||
### Routing
|
### Routing
|
||||||
|
|
||||||
Next, we'll look at the `RouteLoader`, defined in
|
Next, we'll look at the `RouteLoader`, defined in
|
||||||
`src/Util/RoutLoader.php`, which loads all the files from
|
`src/Core/Router/RouteLoader.php`, which loads all the files from
|
||||||
`src/Routes/*.php` and calls the static `load` method, which defines
|
`src/Routes/*.php` and calls the static `load` method, which defines
|
||||||
routes with an interface similar to V2's `connect`, except it requires
|
routes with an interface similar to V2's `connect`, except it requires
|
||||||
an extra identifier as the first argument. This identifier is used,
|
an additional identifier as the first argument. This identifier is used,
|
||||||
for instance, to generate URLs for each route. Each route connects an
|
for instance, to generate URLs for each route. Each route connects a
|
||||||
URL path to a Controller, with the possibility of taking arguments,
|
URL path to a Controller, with the possibility of taking arguments,
|
||||||
which are passed to the `__invoke` method of the respective controller
|
which are passed to the `__invoke` method of the respective controller
|
||||||
or the given method. The controllers are defined in `src/Controller/`
|
or the given method. The controllers are defined in `src/Controller/`
|
||||||
or `plugins/*/Controller` or `components/*/Controller` and are
|
or `plugins/*/Controller` or `components/*/Controller` and are
|
||||||
responsible for handling a request and return a Symfony `Response`
|
responsible for handling a request and return a Symfony `Response`
|
||||||
object or an array that gets converted to one (subject to change, in
|
object, or an array that gets converted to one (subject to change, in
|
||||||
order to abstract HTML vs JSON output).
|
order to abstract HTML vs JSON output).
|
||||||
|
|
||||||
This array conversion is handled by `App\Core\Controller`, along with
|
This array conversion is handled by `App\Core\Controller`, along with
|
||||||
@ -85,11 +85,11 @@ JSON, with what the controller returned.
|
|||||||
The next steps are handled by the Symfony framework which creates a
|
The next steps are handled by the Symfony framework which creates a
|
||||||
`Request` object from the HTTP request, and then a corresponding
|
`Request` object from the HTTP request, and then a corresponding
|
||||||
`Response` is created by `App\Core\Controller`, which matches the
|
`Response` is created by `App\Core\Controller`, which matches the
|
||||||
appropriate route and thus calls it's controller.
|
appropriate route and thus calls its controller.
|
||||||
|
|
||||||
### Performance
|
### Performance
|
||||||
|
|
||||||
All this happens on each request, which seems like a lot to handle,
|
All of this happens on each request, which seems like a lot to handle,
|
||||||
and would be too slow. Fortunately, Symfony has a 'compiler' which
|
and would be too slow. Fortunately, Symfony has a 'compiler' which
|
||||||
caches and optimizes the code paths. In production mode, this can be
|
caches and optimizes the code paths. In production mode, this can be
|
||||||
done through a command, while in development mode, it's handled on
|
done through a command, while in development mode, it's handled on
|
0
docs/developer/src/core/queues.md
Normal file
0
docs/developer/src/core/queues.md
Normal file
0
docs/developer/src/core/security.md
Normal file
0
docs/developer/src/core/security.md
Normal file
0
docs/developer/src/core/util.md
Normal file
0
docs/developer/src/core/util.md
Normal file
0
docs/developer/src/debugging.md
Normal file
0
docs/developer/src/debugging.md
Normal file
Loading…
Reference in New Issue
Block a user