From feb567d4eebec384e9ca2ecdb3c57f620e8ff564 Mon Sep 17 00:00:00 2001
From: Jose Lorenzo Rodriguez <jose.zap@gmail.com>
Date: Thu, 7 Jul 2011 02:34:22 -0430
Subject: [PATCH] Adding better help and documentation for loading plugins. The
 exception renderer will serve a helpful page if a plugin is missing

---
 app/Config/bootstrap.php                      | 13 +++++-
 .../Templates/skel/Config/bootstrap.php       | 13 +++++-
 lib/Cake/View/Errors/missing_plugin.ctp       | 45 +++++++++++++++++++
 3 files changed, 69 insertions(+), 2 deletions(-)
 create mode 100644 lib/Cake/View/Errors/missing_plugin.ctp

diff --git a/app/Config/bootstrap.php b/app/Config/bootstrap.php
index dcf7f58b9..20688cf68 100644
--- a/app/Config/bootstrap.php
+++ b/app/Config/bootstrap.php
@@ -46,9 +46,20 @@ Cache::config('default', array('engine' => 'File'));
  */
 
 /**
- * As of 1.3, additional rules for the inflector are added below
+ * Custom Inflector rules, can be set to correctly pluralize or singularize table, model, controller names or whatever other
+ * string is passed to the inflection functions
  *
  * Inflector::rules('singular', array('rules' => array(), 'irregular' => array(), 'uninflected' => array()));
  * Inflector::rules('plural', array('rules' => array(), 'irregular' => array(), 'uninflected' => array()));
  *
  */
+
+/**
+ * Plugins need to be loaded manually, you can either load them one by one or all of them in a single call
+ * Uncomment one of the lines below, as you need. make sure you read the documentation on CakePlugin to use more
+ * advanced ways of loading plugins
+ *
+ * CakePlugin::loadAll(); // Loads all plugins at once
+ * CakePlugin::load('DebugKit'); //Loads a single plugin named DebugKit
+ *
+ */
\ No newline at end of file
diff --git a/lib/Cake/Console/Templates/skel/Config/bootstrap.php b/lib/Cake/Console/Templates/skel/Config/bootstrap.php
index dcf7f58b9..20688cf68 100644
--- a/lib/Cake/Console/Templates/skel/Config/bootstrap.php
+++ b/lib/Cake/Console/Templates/skel/Config/bootstrap.php
@@ -46,9 +46,20 @@ Cache::config('default', array('engine' => 'File'));
  */
 
 /**
- * As of 1.3, additional rules for the inflector are added below
+ * Custom Inflector rules, can be set to correctly pluralize or singularize table, model, controller names or whatever other
+ * string is passed to the inflection functions
  *
  * Inflector::rules('singular', array('rules' => array(), 'irregular' => array(), 'uninflected' => array()));
  * Inflector::rules('plural', array('rules' => array(), 'irregular' => array(), 'uninflected' => array()));
  *
  */
+
+/**
+ * Plugins need to be loaded manually, you can either load them one by one or all of them in a single call
+ * Uncomment one of the lines below, as you need. make sure you read the documentation on CakePlugin to use more
+ * advanced ways of loading plugins
+ *
+ * CakePlugin::loadAll(); // Loads all plugins at once
+ * CakePlugin::load('DebugKit'); //Loads a single plugin named DebugKit
+ *
+ */
\ No newline at end of file
diff --git a/lib/Cake/View/Errors/missing_plugin.ctp b/lib/Cake/View/Errors/missing_plugin.ctp
new file mode 100644
index 000000000..ef7004fb3
--- /dev/null
+++ b/lib/Cake/View/Errors/missing_plugin.ctp
@@ -0,0 +1,45 @@
+<?php
+/**
+ *
+ * PHP 5
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @package       cake.libs.view.templates.errors
+ * @since         CakePHP(tm) v 0.10.0.1076
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+?>
+<h2><?php echo __d('cake_dev', 'Missing Plugin'); ?></h2>
+<p class="error">
+	<strong><?php echo __d('cake_dev', 'Error'); ?>: </strong>
+	<?php echo __d('cake_dev', 'The application is trying to load a file from the %s plugin', '<em>' . $plugin . '</em>'); ?>
+</p>
+<p class="error">
+	<strong><?php echo __d('cake_dev', 'Error'); ?>: </strong>
+	<?php echo __d('cake_dev', 'Make sure your plugin %s is in the ' . APP_DIR . DS . 'Plugin directory and was loaded', $plugin); ?>
+</p>
+<pre>
+&lt;?php
+CakePlugin::load('<?php echo $plugin?>');
+?&gt;
+</pre>
+<p class="notice">
+	<strong><?php echo __d('cake_dev', 'Loading all plugins'); ?>: </strong>
+	<?php echo __d('cake_dev', 'If you wish to load all plugins at once, use the following line in your ' . APP_DIR . DS . 'bootstrap.php file'); ?>
+</p>
+<pre>
+CakePlugin::loadAll();
+</pre>
+<p class="notice">
+	<strong><?php echo __d('cake_dev', 'Notice'); ?>: </strong>
+	<?php echo __d('cake_dev', 'If you want to customize this error message, create %s', APP_DIR . DS . 'View' . DS . 'Errors' . DS . 'missing_plugin.ctp'); ?>
+</p>
+
+<?php echo $this->element('exception_stack_trace'); ?>