example saving cp form for add-ons

some code fixes

Author: intoeetive

docs/development/modules.md

@@ -27,7 +27,7 @@ NOTE:Before adding a Control Panel route to your add-on, you need to already hav
 If your add-on doesn't already have the required `ControlPanel/Routes` and `views` files, you can add a route to your add-on using the `make:cp-route` command in the CLI.
 
 ```
-$ php system/ee/eeclip.php make:cp-route
+$ php system/ee/eecli.php make:cp-route
 Let's create a control panel route!
 What is the route name? index
 What add-on is the route being added to? [amazing_add_on]:  amazing_add_on
@@ -399,12 +399,44 @@ if (isset($form)) {
 }
 ```
 
-You're add-on will now have a Control Panel page with a form as seen in this screenshot:
+Your add-on will now have a Control Panel page with a form as seen in this screenshot:
 
 ![add-on with form](_images/add-on-view.png)
 
+Finally, make the form submission do something. The form is being submitted to same CP controller, so we can check whether it has been submitted by adding `ee('Request')->isPost()` check. For the sake of this demo, we'll skip the database saving part and just display success message on submission.
 
-TIP: This is only the beginning of what you can do with forms in the Control Panel. Read more in the docs on the [`CP\Form` service](development/services/cp-form.md)() to understand what else is possible.
+```
+public function process($id = false)
+{
+  if (ee('Request')->isPost()) {
+    ee('CP/Alert')->makeBanner('amazing_add_on')
+      ->asSuccess()
+      ->withTitle(lang('success'))
+      ->addToBody('Form has been submitted!')
+      ->now();
+  }
+
+  // set the breadcrumb
+  $this->addBreadcrumb('index', 'Home');
+
+  // call our getForm() method to get
+  // our array
+  $form = $this->getForm();
+
+  // store our form in our $variables array
+  // to be passed into our view
+  $variables = [
+    'form'  => $form
+  ];
+
+  $this->setBody('Index', $variables);
+
+  return $this;
+}
+```
+
+
+TIP: This is only the beginning of what you can do with forms in the Control Panel. Read more in the docs on the [`CP\Form` service](development/services/cp-form.md) to understand what else is possible.
 
 TIP: **{ee:u}** Learn more about the [CP\Form service on ExpressionEngine University](https://u.expressionengine.com/article/ultra-double-secret-manual-shared-form-part-four).
 

docs/development/services/cp-form.md

@@ -7,17 +7,17 @@
     @license   https://expressionengine.com/license Licensed under Apache License, Version 2.0
 -->
 
-# Cp/Form Service
+# CP/Form Service
 
 [TOC]
 
-The Cp/Form Service allows for the creation of Shared Form View data using an object oriented interface. 
+The CP/Form Service allows for the creation of Shared Form View data using an object oriented interface. 
 
 TIP: Note this requires PHP >= 7.1
 
 ## Usage
 
-The below shows The Cp/Form Service at its simplest; every form can contain multiple groups, which can contain multiple field sets, which can contain multiple fields.
+The below shows The CP/Form Service at its simplest; every form can contain multiple groups, which can contain multiple field sets, which can contain multiple fields.
 
 ### Basic 
 ```
@@ -53,7 +53,7 @@ $form->toArray();
 ```
 ## API Reference
 
-**class `ExpressionEngine\Library\Cp\Form`**
+**class `ExpressionEngine\Library\CP\Form`**
 
 This object contains the complete outline for your Shared Form View array. For simple forms, all you'll have to do is call the Service using EE's loader, but for more complex Forms, you have quite a few options available. 
 
@@ -65,7 +65,7 @@ Will output the Form object as a Tabbed format array form.
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `isTab()`
 
@@ -81,7 +81,7 @@ Will output the Form object as a linear array form (the default)
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `getGroup($group_name)`
 
@@ -104,15 +104,15 @@ Removes the specified group from the Form object
 
 ### `toArray()`
 
-Returns the entire Cp\Form object into an array compatible with the Shared Form View layer. Note that all child elements are converted to an array as well.
+Returns the entire CP\Form object into an array compatible with the Shared Form View layer. Note that all child elements are converted to an array as well.
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | Returns | `array` | The complete Shared Form View array |
 
 ### `render()`
 
-Returns the entire Cp\Form object as a string for use within the Control Panel.
+Returns the entire CP\Form object as a string for use within the Control Panel.
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
@@ -124,16 +124,16 @@ Sets the Shared Form View layer to set the form input's `enctype` to multipart/f
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `addAlert($alert_name)`
 
-Sets the Form to render specific Cp/Alert objects
+Sets the Form to render specific CP/Alert objects
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$alert_name | `string` | The name for the Alert |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `removeAlert($alert_name)`
 
@@ -152,7 +152,7 @@ Will return the specified `Form\Button` object if it exists, or prepare and retu
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$name | `string` | The name for the Button |
-| Returns | `Cp\Form\Button` | The Button object ready for use |
+| Returns | `CP\Form\Button` | The Button object ready for use |
 
 ### `removeButton($name)`
 
@@ -170,7 +170,7 @@ Will return the specified `Form\Fields\Hidden` object if it exists, or prepare a
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$name | `string` | The name for the Button |
-| Returns | `Cp\Form\Fields\Hidden` | The Hidden Field object |
+| Returns | `CP\Form\Fields\Hidden` | The Hidden Field object |
 
 ### `removeHiddenField($name)`
 
@@ -190,15 +190,15 @@ Will include a custom HTML button with a link in lieu of the top right button of
 | \$text | `string` | The value to display on your custom button |
 | \$href | `string` | What URL to send the user to |
 | \$rel | `string` | For HTML directives |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `withOutActionButton()`
 
 Will remove the set action button
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `setCpPageTitle($text)`
 
@@ -207,7 +207,7 @@ Sets the string to use for the Page Title within the Control Panel
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$text | `string` | The name for the page |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `getCpPageTitle()`
 
@@ -224,7 +224,7 @@ Sets the string to use for the Alternative Page Title within the Control Panel (
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$text | `string` | The name for the page |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `getCpPageTitle()`
 
@@ -241,7 +241,7 @@ Sets the internal Alerts ID to use specific to this Form (`alerts_name`)
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$text | `string` | The name for the page |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `getAlertsName()`
 
@@ -258,7 +258,7 @@ The URL to process the Form (`base_url`)
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |
 | \$url | `string` | The URL the form should be processed at |
-| Returns | `Cp\Form` | `$this`, the Form object to help in chaining |
+| Returns | `CP\Form` | `$this`, the Form object to help in chaining |
 
 ### `getBaseUrl()`
 

docs/development/services/cp-form/buttons.md

@@ -26,7 +26,7 @@ $button->setType('submit')->setText('Submit Button')
 
 ## API Reference
 
-**class `ExpressionEngine\Library\Cp\Form\Button`**
+**class `ExpressionEngine\Library\CP\Form\Button`**
 
 [TOC=3]
 
@@ -40,7 +40,7 @@ Returns the name used upon creation for the Button and the id.
 
 ### `toArray()`
 
-Returns the entire `Cp\Form\Button` object into an array. 
+Returns the entire `CP\Form\Button` object into an array. 
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |

docs/development/services/cp-form/field-sets.md

@@ -33,13 +33,13 @@ It's important to note that while Field Sets are built to contain multiple Field
 
 ## API Reference
 
-**class `ExpressionEngine\Library\Cp\Form\Set`**
+**class `ExpressionEngine\Library\CP\Form\Set`**
 
 [TOC=3]
 
 ### `toArray()`
 
-Returns the entire `Cp\Form\Set` object into an array. Note that all child elements are converted to an array as well.
+Returns the entire `CP\Form\Set` object into an array. Note that all child elements are converted to an array as well.
 
 | Parameter | Type | Description |
 | --------- | ---- | ----------- |