From 8237e73e26592d4bedf71438a30f4725f0c557c3 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sun, 3 Mar 2019 15:05:35 +0100 Subject: [PATCH] Adding REAMDEs to directories --- src/Core/Cache.php | 2 +- src/Core/Lock.php | 2 +- src/Core/README.md | 4 ++++ src/{Core/Cache => Factory}/CacheDriverFactory.php | 12 +++++++----- src/Factory/README.md | 9 +++++++++ src/Model/README.md | 5 +++++ src/Module/README.md | 10 ++++++++++ src/Object/README.md | 5 +++++ src/Worker/README.md | 6 ++++++ 9 files changed, 48 insertions(+), 7 deletions(-) create mode 100644 src/Core/README.md rename src/{Core/Cache => Factory}/CacheDriverFactory.php (73%) create mode 100644 src/Factory/README.md create mode 100644 src/Model/README.md create mode 100644 src/Module/README.md create mode 100644 src/Object/README.md create mode 100644 src/Worker/README.md diff --git a/src/Core/Cache.php b/src/Core/Cache.php index cadb2444b..7a8f7367e 100644 --- a/src/Core/Cache.php +++ b/src/Core/Cache.php @@ -4,7 +4,7 @@ */ namespace Friendica\Core; -use Friendica\Core\Cache\CacheDriverFactory; +use Friendica\Factory\CacheDriverFactory; /** * @brief Class for storing data for a short time diff --git a/src/Core/Lock.php b/src/Core/Lock.php index 8bc2c242d..a45490bf3 100644 --- a/src/Core/Lock.php +++ b/src/Core/Lock.php @@ -7,7 +7,7 @@ namespace Friendica\Core; -use Friendica\Core\Cache\CacheDriverFactory; +use Friendica\Factory\CacheDriverFactory; use Friendica\Core\Cache\IMemoryCacheDriver; /** diff --git a/src/Core/README.md b/src/Core/README.md new file mode 100644 index 000000000..8a5a3788b --- /dev/null +++ b/src/Core/README.md @@ -0,0 +1,4 @@ +## Friendica\Core + +The Core namespace contains classes, which are essential to Friendica. + \ No newline at end of file diff --git a/src/Core/Cache/CacheDriverFactory.php b/src/Factory/CacheDriverFactory.php similarity index 73% rename from src/Core/Cache/CacheDriverFactory.php rename to src/Factory/CacheDriverFactory.php index 307f52a2e..1008b6794 100644 --- a/src/Core/Cache/CacheDriverFactory.php +++ b/src/Factory/CacheDriverFactory.php @@ -1,8 +1,10 @@ `Contact`) +- Start with capitals and are **not** camelCased. +- Directly interacting with a given request (POST or GET) +- Extending [`BaseModule`](https://github.com/friendica/friendica/blob/develop/src/BaseModule.php). \ No newline at end of file diff --git a/src/Object/README.md b/src/Object/README.md new file mode 100644 index 000000000..e4089db08 --- /dev/null +++ b/src/Object/README.md @@ -0,0 +1,5 @@ +## Friendica\Object + +The namespace Object contains dynamic classes which are **note** directly interacting with the datastore. + +They are used to implement business logic for a particular object (i.e. an Image). \ No newline at end of file diff --git a/src/Worker/README.md b/src/Worker/README.md new file mode 100644 index 000000000..fc937b33b --- /dev/null +++ b/src/Worker/README.md @@ -0,0 +1,6 @@ +## Friendica\Worker + +The Worker namespace contains all asynchronous workers of Friendica. +The all have to implement the function `public static function execute()`. + +They are all executed by the [`Worker`](https://github.com/friendica/friendica/blob/develop/src/Core/Worker.php). \ No newline at end of file