From: Philipp Holzer <admin@philipp.info>
Date: Sun, 3 Mar 2019 14:05:35 +0000 (+0100)
Subject: Adding REAMDEs to directories
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=8237e73e26592d4bedf71438a30f4725f0c557c3;p=friendica.git

Adding REAMDEs to directories
---

diff --git a/src/Core/Cache.php b/src/Core/Cache.php
index cadb2444b5..7a8f7367ec 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/Cache/CacheDriverFactory.php b/src/Core/Cache/CacheDriverFactory.php
deleted file mode 100644
index 307f52a2ea..0000000000
--- a/src/Core/Cache/CacheDriverFactory.php
+++ /dev/null
@@ -1,48 +0,0 @@
-<?php
-
-namespace Friendica\Core\Cache;
-
-use Friendica\Core\Config;
-
-/**
- * Class CacheDriverFactory
- *
- * @package Friendica\Core\Cache
- *
- * A basic class to generate a CacheDriver
- */
-class CacheDriverFactory
-{
-	/**
-	 * This method creates a CacheDriver for the given cache driver name
-	 *
-	 * @param string $driver The name of the cache driver
-	 * @return ICacheDriver  The instance of the CacheDriver
-	 * @throws \Exception    The exception if something went wrong during the CacheDriver creation
-	 */
-	public static function create($driver) {
-
-		switch ($driver) {
-			case 'memcache':
-				$memcache_host = Config::get('system', 'memcache_host');
-				$memcache_port = Config::get('system', 'memcache_port');
-
-				return new MemcacheCacheDriver($memcache_host, $memcache_port);
-				break;
-
-			case 'memcached':
-				$memcached_hosts = Config::get('system', 'memcached_hosts');
-
-				return new MemcachedCacheDriver($memcached_hosts);
-				break;
-			case 'redis':
-				$redis_host = Config::get('system', 'redis_host');
-				$redis_port = Config::get('system', 'redis_port');
-
-				return new RedisCacheDriver($redis_host, $redis_port);
-				break;
-			default:
-				return new DatabaseCacheDriver();
-		}
-	}
-}
diff --git a/src/Core/Lock.php b/src/Core/Lock.php
index 8bc2c242d1..a45490bf39 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 0000000000..8a5a3788b5
--- /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/Factory/CacheDriverFactory.php b/src/Factory/CacheDriverFactory.php
new file mode 100644
index 0000000000..1008b67944
--- /dev/null
+++ b/src/Factory/CacheDriverFactory.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Friendica\Factory;
+
+use Friendica\Core\Cache\ICacheDriver;
+use Friendica\Core\Config;
+use Friendica\Core\Cache;
+
+/**
+ * Class CacheDriverFactory
+ *
+ * @package Friendica\Core\Cache
+ *
+ * A basic class to generate a CacheDriver
+ */
+class CacheDriverFactory
+{
+	/**
+	 * This method creates a CacheDriver for the given cache driver name
+	 *
+	 * @param string $driver The name of the cache driver
+	 * @return ICacheDriver  The instance of the CacheDriver
+	 * @throws \Exception    The exception if something went wrong during the CacheDriver creation
+	 */
+	public static function create($driver) {
+
+		switch ($driver) {
+			case 'memcache':
+				$memcache_host = Config::get('system', 'memcache_host');
+				$memcache_port = Config::get('system', 'memcache_port');
+
+				return new Cache\MemcacheCacheDriver($memcache_host, $memcache_port);
+				break;
+
+			case 'memcached':
+				$memcached_hosts = Config::get('system', 'memcached_hosts');
+
+				return new Cache\MemcachedCacheDriver($memcached_hosts);
+				break;
+			case 'redis':
+				$redis_host = Config::get('system', 'redis_host');
+				$redis_port = Config::get('system', 'redis_port');
+
+				return new Cache\RedisCacheDriver($redis_host, $redis_port);
+				break;
+			default:
+				return new Cache\DatabaseCacheDriver();
+		}
+	}
+}
diff --git a/src/Factory/README.md b/src/Factory/README.md
new file mode 100644
index 0000000000..572d9403c9
--- /dev/null
+++ b/src/Factory/README.md
@@ -0,0 +1,9 @@
+## Friendica\Factory
+
+This namespace contains Factories.
+A Factory is used to create specific objects based on its configuration.
+
+See [Factory Method](https://designpatternsphp.readthedocs.io/en/latest/Creational/FactoryMethod/README.html)
+
+Use the classes inside this directory if you want to change the way how new objects should get created.
+Don't use the classes to change the behaviour of the concrete objects.
diff --git a/src/Model/README.md b/src/Model/README.md
new file mode 100644
index 0000000000..fb41e7309a
--- /dev/null
+++ b/src/Model/README.md
@@ -0,0 +1,5 @@
+### Friendica\Model
+
+Models are the glue between the business logic of the app and the datastore(s).
+
+In the namespace Model should only be static classes that interact with the DB with the same name as a database table.
\ No newline at end of file
diff --git a/src/Module/README.md b/src/Module/README.md
new file mode 100644
index 0000000000..f888f26326
--- /dev/null
+++ b/src/Module/README.md
@@ -0,0 +1,10 @@
+## Friendica\Module
+
+The Module namespace contains the different modules of Friendica.
+Each module is loaded through the [`App`](https://github.com/friendica/friendica/blob/develop/src/App.php).
+
+Rules for Modules:
+- 	Named like the call (i.e. https://friendica.test/contact => `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 0000000000..e4089db089
--- /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 0000000000..fc937b33bc
--- /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