Merge branch 'develop' of github.com:bcit-ci/CodeIgniter4 into develop

Author: lonnieezell

application/Config/Routes.php

@@ -73,7 +73,7 @@
 
 // We get a performance increase by specifying the default
 // route since we don't have to scan directories.
-$routes->add('/', 'Home::index');
+$routes->get('/', 'Home::index');
 
 /**
  * --------------------------------------------------------------------

contributing/index.rst contributing/README.rstcontributing/index.rst renamed to contributing/README.rst

@@ -3,7 +3,7 @@
 # ----------------------------------------------------------------------
 
 # Sets the environment that CodeIgniter runs under.
- SetEnv CI_ENVIRONMENT development
+# SetEnv CI_ENVIRONMENT development
 
 # ----------------------------------------------------------------------
 # UTF-8 encoding

public/.htaccess

@@ -221,6 +221,14 @@ public function __set(string $key, $value = null)
 			$value = serialize($value);
 		}
 
+		// JSON casting requires that we JSONize the value
+		// when setting it so that it can easily be stored
+		// back to the database.
+		if (function_exists('json_encode') && array_key_exists($key, $this->_options['casts']) && ($this->_options['casts'][$key] === 'json' || $this->_options['casts'][$key] === 'json-array'))
+		{
+			$value = json_encode($value);
+		}
+
 		// if a set* method exists for this key,

 		// use that method to insert this value.

 		$method = 'set' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $key)));
@@ -360,6 +368,7 @@ protected function mutateDate($value)
 	 *
 	 * @return mixed
 	 */
+	
 	protected function castAs($value, string $type)
 	{
 		switch($type)
@@ -390,6 +399,12 @@ protected function castAs($value, string $type)
 
 				$value = (array)$value;
 				break;
+			case 'json':
+				$value = $this->castAsJson($value, false);
+				break;
+			case 'json-array':
+				$value = $this->castAsJson($value, true);
+				break;
 			case 'datetime':
 				return new \DateTime($value);
 				break;
@@ -400,4 +415,32 @@ protected function castAs($value, string $type)
 
 		return $value;
 	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Cast as JSON
+	 *
+	 * @param mixed $value
+	 * @param bool $asArray 
+	 *
+	 * @return mixed
+	 */
+	private function castAsJson($value, bool $asArray = false)
+	{
+		$tmp = !is_null($value) ? ($asArray ? [] : new \stdClass) : null;
+		if(function_exists('json_decode'))
+		{
+			if((is_string($value) && (strpos($value, '[') === 0 || strpos($value, '{') === 0 || (strpos($value, '"') === 0 && strrpos($value, '"') === 0 ))) || is_numeric($value))
+			{
+				$tmp = json_decode($value, $asArray);
+
+				if(json_last_error() !== JSON_ERROR_NONE)
+				{
+					throw CastException::forInvalidJsonFormatException(json_last_error());
+				}
+			}
+		}
+		return $tmp;
+	}
 }

system/Entity.php

@@ -0,0 +1,40 @@
+<?php namespace CodeIgniter\Exceptions;
+
+/**
+ * Cast Exceptions.
+ */
+class CastException extends CriticalError
+{
+
+	/**
+	 * Error code
+	 * @var int
+	 */
+	protected $code = 3;
+
+	public static function forInvalidJsonFormatException(int $error)
+	{	
+		switch($error)
+		{
+			case JSON_ERROR_DEPTH:
+				throw new static(lang('Cast.jsonErrorDepth'));
+				break;
+			case JSON_ERROR_STATE_MISMATCH:
+				throw new static(lang('Cast.jsonErrorStateMismatch'));
+				break;
+			case JSON_ERROR_CTRL_CHAR:
+				throw new static(lang('Cast.jsonErrorCtrlChar'));
+				break;
+			case JSON_ERROR_SYNTAX:
+				throw new static(lang('Cast.jsonErrorSyntax'));
+				break;
+			case JSON_ERROR_UTF8:
+				throw new static(lang('Cast.jsonErrorUtf8'));
+				break;
+			default:
+				throw new static(lang('Cast.jsonErrorUnknown'));
+		}
+
+	}
+
+}

system/Exceptions/CastException.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Cast language strings.
+ *
+ * @package      CodeIgniter
+ * @author       CodeIgniter Dev Team
+ * @copyright    2014-2018 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
+ * 
+ * @codeCoverageIgnore
+ */
+
+return [
+	'jsonErrorDepth' 		=> 'Maximum stack depth exceeded',
+	'jsonErrorStateMismatch'	=> 'Underflow or the modes mismatch',
+	'jsonErrorCtrlChar'	=> 'Unexpected control character found',
+	'jsonErrorSyntax'		=> 'Syntax error, malformed JSON',
+	'jsonErrorUtf8'		=> 'Malformed UTF-8 characters, possibly incorrectly encoded',
+	'jsonErrorUnknown'		=> 'Unknown error'
+];

system/Language/en/Cast.php

@@ -0,0 +1,71 @@
+###########################
+Contributing to CodeIgniter
+###########################
+
+CodeIgniter is a community driven project and accepts contributions of code
+and documentation from the community. These contributions are made in the form
+of Issues or `Pull Requests <https://help.github.com/articles/using-pull-requests/>`_
+on the `CodeIgniter4 repository <https://github.com/bcit-ci/CodeIgniter4>`_ on GitHub.
+
+Issues are a quick way to point out a bug. If you find a bug or documentation
+error in CodeIgniter then please check a few things first:
+
+- There is not already an open Issue
+- The issue has already been fixed (check the develop branch, or look for
+  closed Issues)
+- Is it something really obvious that you fix it yourself?
+
+Reporting issues is helpful but an even better approach is to send a Pull
+Request, which is done by "Forking" the main repository and committing to your
+own copy. This will require you to use the version control system called Git.
+
+Please see the `Contributing to CodeIgniter4 <https://github.com/bcit-ci/CodeIgniter4/tree/develop/contributing>`_ 
+section of our code repository.
+
+
+*******
+Support
+*******
+
+Please note that GitHub is not for general support questions! If you are
+having trouble using a feature of CodeIgniter, ask for help on our
+`forums <http://forum.codeigniter.com/>`_ instead.
+
+If you are not sure whether you are using something correctly or if you
+have found a bug, again - please ask on the forums first.
+
+********
+Security
+********
+
+Did you find a security issue in CodeIgniter?
+
+Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com,
+or report it via our page on `HackerOne <https://hackerone.com/codeigniter>`_.
+
+If you've found a critical vulnerability, we'd be happy to credit you in our
+`ChangeLog <https://bcit-ci.github.io/CodeIgniter4/changelog.html>`_.
+
+****************************
+Tips for a Good Issue Report
+****************************
+
+Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke).
+
+Address a single issue in a report.
+
+Identify the CodeIgniter version (eg 4.0.1) and the component if you know it (eg. parser library)
+
+Explain what you expected to happen, and what did happen.
+Include error messages and stacktrace, if any.
+
+Include short code segments if they help to explain.
+Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself.
+This means setting a reasonable expiry for those, until the issue is resolved or closed.
+
+If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request.
+The issue report information above should be part of that.
+
+If your issue report can describe the steps to reproduce the problem, that is great.
+If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing
+it a clearer target!

user_guide_src/source/extending/contributing.rst

@@ -9,3 +9,4 @@ CodeIgniter 4 has been designed to be easy to extend or build upon.
 
     core_classes
     events
+    contributing

user_guide_src/source/extending/index.rst

@@ -4,6 +4,9 @@ Installation
 
 CodeIgniter4 can be installed manually, or using Composer.
 
+.. note:: Before using CodeIgniter, make sure that your server meets the
+          :doc:`requirements </intro/requirements>`.
+
 Manual Installation
 ===================
 

user_guide_src/source/installation/index.rst

@@ -2,7 +2,15 @@
 Server Requirements
 ###################
 
-`PHP <http://php.net/>`_ version 7.1 or newer is required, with the *intl* extension installed. `Why 7.1 <https://gophp71.org/>`_?
+`PHP <http://php.net/>`_ version 7.1 or newer is required, with the 
+`*intl* extension <http://php.net/manual/en/intl.requirements.php>`_ 
+installed. `Why 7.1 <https://gophp71.org/>`_?
+
+The following PHP extensions should be enabled on your server:
+``php-json``, ``php-mbstring``, ``php-mysqlnd``, `php-xml``
+
+In order to use the :doc:`CURLRequest </libraries/curlrequest>`, you will need 
+`libcurl <http://php.net/manual/en/curl.requirements.php>`_ installed.
 
 A database is required for most web application programming.
 Currently supported databases are: