Merge pull request #1 from codeigniter4/develop

Update develop branch

app/Config/Events.php

@@ -19,23 +19,25 @@
  *      Events::on('create', [$myInstance, 'myMethod']);
  */
 
-/*
- * --------------------------------------------------------------------
- * Debug Toolbar Listeners.
- * --------------------------------------------------------------------
- * If you delete, they will no longer be collected.
- */
-if (ENVIRONMENT !== 'production')
-{
-	Events::on('DBQuery', 'CodeIgniter\Debug\Toolbar\Collectors\Database::collect');
+Events::on('pre_system', function () {
+	while (\ob_get_level() > 0)
+	{
+		\ob_end_flush();
+	}
 
-	Events::on('pre_system', function () {
-		if (ENVIRONMENT !== 'testing')
-		{
-			\ob_start(function ($buffer) {
-				return $buffer;
-			});
-		}
-		Services::toolbar()->respond();
+	\ob_start(function ($buffer) {
+		return $buffer;
 	});
-}
+
+	/*
+	 * --------------------------------------------------------------------
+	 * Debug Toolbar Listeners.
+	 * --------------------------------------------------------------------
+	 * If you delete, they will no longer be collected.
+	 */
+	if (ENVIRONMENT !== 'production')
+	{
+		Events::on('DBQuery', 'CodeIgniter\Debug\Toolbar\Collectors\Database::collect');
+		Services::toolbar()->respond();
+	}
+});

app/Controllers/BaseController.php

@@ -0,0 +1,46 @@
+<?php namespace App\Controllers;
+
+/**
+ * Class BaseController
+ *
+ * BaseController provides a convenient place for loading components
+ * and performing functions that are needed by all your controllers.
+ * Extend this class in any new controllers:
+ *     class Home extends BaseController
+ * 
+ * For security be sure to declare any new methods as protected or private.
+ * 
+ * @package CodeIgniter
+ */
+
+use CodeIgniter\Controller;
+
+class BaseController extends Controller
+{
+
+	/**
+	 * An array of helpers to be loaded automatically upon
+	 * class instantiation. These helpers will be available
+	 * to all other controllers that extend BaseController.
+	 *
+	 * @var array
+	 */
+	protected $helpers = [ ];
+
+	/**
+	 * Constructor.
+	 *
+	 */
+	public function initController(\CodeIgniter\HTTP\RequestInterface $request, \CodeIgniter\HTTP\ResponseInterface $response, \Psr\Log\LoggerInterface $logger)
+	{
+		// Do Not Edit This Line
+		parent::initController($request, $response, $logger);
+
+		//--------------------------------------------------------------------
+		// Preload any models, libraries, etc, here.
+		//--------------------------------------------------------------------
+		// E.g.:
+		// $this->session = \Config\Services::session();
+
+	}
+}

app/Controllers/Home.php

@@ -2,7 +2,7 @@
 
 use CodeIgniter\Controller;
 
-class Home extends Controller
+class Home extends BaseController
 {
 	public function index()
 	{

contributing/styleguide.rst

@@ -247,6 +247,82 @@ Control Structures
         if ( $foo ) $bar += $baz;
         else $baz = 'bar';
 
+Docblocks
+=========
+
+We use phpDocumentor (phpdoc) to generate the API docs, for all of the source
+code inside the `system` folder.
+
+It wants to see a file summary docblock at the top of a PHP file,
+before any PHP statements, and then a docblock before each documentable
+component, namely any class/interface/trait, and all public and protected
+methods/functions/variables. The docblock for a method or function
+is expected to describe the parameters, return value, and any exceptions
+thrown.
+
+Deviations from the above are considered errors by phpdoc.
+
+An example::
+
+    <?php
+
+    /**
+     * CodeIgniter
+     *
+     * An open source application development framework for PHP
+     *
+     ...
+     *
+     * @package    CodeIgniter
+     * @author     CodeIgniter Dev Team
+     * @copyright  2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
+     * @license    https://opensource.org/licenses/MIT	MIT License
+     * @link       https://codeigniter.com
+     * @since      Version 3.0.0
+     * @filesource
+     */
+    namespace CodeIgniter\Fruit;
+    use CodeIgniter\Config\BaseConfig;
+
+    /**
+     * Base class for entities in the CodeIgniter\Fruit module.
+     *
+     * @property $group
+     * @property $name
+     * @property $description
+     *
+     * @package CodeIgniter\Fruit
+     */
+    abstract class BaseFruit
+    {
+
+            /**
+             * The group a fruit belongs to.
+             *
+             * @var string
+             */
+            protected $group;
+
+            /**
+             * Fruit constructor.
+             *
+             * @param BaseConfig       $config
+             */
+            public function __construct(BaseConfig $Config)
+            {
+                    $this->group   = 'Unknown';
+            }
+
+            //--------------------------------------------------------------------
+
+            /**
+             * Model a fruit ripening over time.
+             * 
+             * @param	array	$params
+             */
+            abstract public function ripen(array $params);
+    }
+
 Other
 =====
 

phpdoc.dist.xml

@@ -8,21 +8,21 @@
         <target>api/build/</target>
     </transformer>
     <files>
-        <directory>./system</directory>
-        <ignore>./vendor/*</ignore>
-        <ignore>./tests/*</ignore>
+        <directory>system</directory>
+        <ignore>vendor/*</ignore>
+        <ignore>tests/*</ignore>
         <ignore>Kint/*</ignore>
     </files>
 
     <logging>
-        <level>warn</level>
+        <level>err</level>
         <paths>
             <default>api/log/{DATE}.log</default>
             <errors>api/{DATE}.errors.log</errors>
         </paths>
     </logging>
 
     <transformations>
-        <template name="responsive" />
+        <template name="responsive-twig" />
     </transformations>
 </phpdoc>

system/API/ResponseTrait.php

@@ -1,4 +1,4 @@
-<?php namespace CodeIgniter\API;
+<?php
 
 /**
  * CodeIgniter
@@ -36,6 +36,8 @@
  * @filesource
  */
 
+namespace CodeIgniter\API;
+
 use Config\Format;
 use CodeIgniter\HTTP\Response;
 

system/Autoloader/Autoloader.php

@@ -1,6 +1,4 @@
-<?php namespace CodeIgniter\Autoloader;
-
-use Composer\Autoload\ClassLoader;
+<?php
 
 /**
  * CodeIgniter
@@ -38,6 +36,8 @@
  * @filesource
  */
 
+namespace CodeIgniter\Autoloader;
+
 /**
  * CodeIgniter Autoloader
  *

system/Autoloader/FileLocator.php

@@ -1,4 +1,4 @@
-<?php namespace CodeIgniter\Autoloader;
+<?php
 
 /**
  * CodeIgniter
@@ -36,6 +36,8 @@
  * @filesource
  */
 
+namespace CodeIgniter\Autoloader;
+
 /**
  * Class FileLocator
  *
@@ -376,6 +378,48 @@ public function listFiles(string $path): array
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Scans the provided namespace, returning a list of all files
+	 * that are contained within the subpath specified by $path.
+	 *
+	 * @param string $prefix
+	 * @param string $path
+	 *
+	 * @return array
+	 */
+	public function listNamespaceFiles(string $prefix, string $path): array
+	{
+		if (empty($path) || empty($prefix))
+		{
+			return [];
+		}
+
+		$files = [];
+		helper('filesystem');
+
+		// autoloader->getNamespace($prefix) returns an array of paths for that namespace
+		foreach ($this->autoloader->getNamespace($prefix) as $namespacePath)
+		{
+			$fullPath = realpath($namespacePath . $path);
+
+			if (! is_dir($fullPath))
+			{
+				continue;
+			}
+
+			$tempFiles = get_filenames($fullPath, true);
+
+			if (! empty($tempFiles))
+			{
+				$files = array_merge($files, $tempFiles);
+			}
+		}
+
+		return $files;
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * Checks the application folder to see if the file can be found.
 	 * Only for use with filenames that DO NOT include namespacing.

system/CLI/BaseCommand.php

@@ -1,5 +1,4 @@
-<?php namespace CodeIgniter\CLI;
-
+<?php
 /**
  * CodeIgniter
  *
@@ -36,6 +35,8 @@
  * @filesource
  */
 
+namespace CodeIgniter\CLI;
+
 use Psr\Log\LoggerInterface;
 
 /**
@@ -94,6 +95,8 @@ abstract class BaseCommand
 	protected $arguments = [];
 
 	/**
+	 * The Logger to use for a command
+	 *
 	 * @var \Psr\Log\LoggerInterface
 	 */
 	protected $logger;
@@ -122,6 +125,12 @@ public function __construct(LoggerInterface $logger, CommandRunner $commands)
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Actually execute a command.
+	 * This has to be over-ridden in any concrete implementation.
+	 *
+	 * @param array $params
+	 */
 	abstract public function run(array $params);
 
 	//--------------------------------------------------------------------