Skip to content

Commit 8ca894a

Browse files
authored
Merge pull request #1241 from jim-parry/docs/restructure
Docs/restructure
2 parents 00a096e + 3ba1b21 commit 8ca894a

55 files changed

Lines changed: 207 additions & 136 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Running via the Command Line
33
############################
44

5-
As well as calling an applications :doc:`Controllers <./controllers>`
5+
As well as calling an applications :doc:`Controllers </incoming/controllers>`
66
via the URL in a browser they can also be loaded via the command-line
77
interface (CLI).
88

@@ -93,7 +93,7 @@ works exactly like a normal route definition::
9393

9494
$routes->cli('tools/message/(:segment)', 'Tools::message/$1');
9595

96-
For more information, see the :doc:`Routes </general/routing>` page.
96+
For more information, see the :doc:`Routes </incoming/routing>` page.
9797

9898
The CLI Library
9999
---------------
@@ -102,4 +102,4 @@ The CLI library makes working with the CLI interface simple.
102102
It provides easy ways to output text in multiple colors to the terminal window. It also
103103
allows you to prompt a user for information, making it easy to build flexible, smart tools.
104104

105-
See the :doc:`CLI Library </libraries/cli>` page for detailed information.
105+
See the :doc:`CLI Library </cli/cli_library>` page for detailed information.

user_guide_src/source/general/cli_commands.rst renamed to user_guide_src/source/cli/cli_commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Then **foo** is the command name, and the ``$params`` array would be::
120120

121121
$params = ['bar', 'baz'];
122122

123-
This can also be accessed through the :doc:`CLI </libraries/cli>` library, but this already has your command removed
123+
This can also be accessed through the :doc:`CLI </cli/cli_library>` library, but this already has your command removed
124124
from the string. These parameters can be used to customize how your scripts behave.
125125

126126
Our demo command might have a ``run`` method something like::
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
##################
2+
Command Line Usage
3+
##################
4+
5+
CodeIgniter 4 can also be used with command line programs.
6+
7+
.. toctree::
8+
:titlesonly:
9+
10+
cli
11+
cli_commands
12+
cli_library

user_guide_src/source/concepts/http.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Working with Requests and Responses
6767
-----------------------------------
6868

6969
While PHP provides ways to interact with the request and response headers, CodeIgniter, like most frameworks,
70-
abstracts them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </libraries/incomingrequest>`
70+
abstracts them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </incoming/incomingrequest>`
7171
is an object-oriented representation of the HTTP request. It provides everything you need::
7272

7373
use CodeIgniter\HTTP\IncomingRequest;
@@ -97,7 +97,7 @@ is an object-oriented representation of the HTTP request. It provides everything
9797
The request class does a lot of work in the background for you, that you never need to worry about.
9898
The ``isAJAX()`` and ``isSecure()`` methods check several different methods to determine the correct answer.
9999

100-
CodeIgniter also provides a :doc:`Response class </libraries/response>` that is an object-oriented representation
100+
CodeIgniter also provides a :doc:`Response class </incoming/response>` that is an object-oriented representation
101101
of the HTTP response. This gives you an easy and powerful way to construct your response to the client::
102102

103103
use CodeIgniter\HTTP\Response;

user_guide_src/source/concepts/mvc.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You might store the view file for this method in **/application/Views/User/Profi
4646
That type of organization works great as a base habit to get into. At times you might need to organize it differently.
4747
That's not a problem. As long as CodeIgniter can find the file, it can display it.
4848

49-
:doc:`Find out more about views </general/views>`
49+
:doc:`Find out more about views </outgoing/views>`
5050

5151
Models
5252
======
@@ -63,7 +63,7 @@ miss updating an area.
6363

6464
Models are typically stored in **/application/Models**, though they can use a namespace to be grouped however you need.
6565

66-
:doc:`Find out more about models </database/model>`
66+
:doc:`Find out more about models </models/model>`
6767

6868
Controllers
6969
===========
@@ -80,4 +80,4 @@ be there, and they get the data they need in a format they can use.
8080
Controllers are typically stored in **/application/Controllers**, though they can use a namespace to be grouped however
8181
you need.
8282

83-
:doc:`Find out more about controllers </general/controllers>`
83+
:doc:`Find out more about controllers </incoming/controllers>`

user_guide_src/source/concepts/security.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ OWASP recommendations
3434
CodeIgniter provisions
3535
----------------------
3636

37-
- `HTTP library <../libraries/message.html>`_ provides for input field filtering & content metadata
37+
- `HTTP library </incoming/message.html>`_ provides for input field filtering & content metadata
3838
- Form validation library
3939

4040
*********************************************
@@ -57,7 +57,7 @@ CodeIgniter provisions
5757
----------------------
5858

5959
- `Session <../libraries/sessions.html>`_ library
60-
- `HTTP library <../libraries/message.html>`_ provides for CSRF validation
60+
- `HTTP library </incoming/message.html>`_ provides for CSRF validation
6161
- Easy to add third party authentication
6262

6363
*****************************
@@ -162,7 +162,7 @@ CodeIgniter provisions
162162
----------------------
163163

164164
- Public folder, with application and system outside
165-
- `HTTP library <../libraries/message.html>`_ provides for CSRF validation
165+
- `HTTP library </incoming/message.html>`_ provides for CSRF validation
166166

167167
************************************
168168
A8 Cross Site Request Forgery (CSRF)
@@ -181,7 +181,7 @@ OWASP recommendations
181181
CodeIgniter provisions
182182
----------------------
183183

184-
- `HTTP library <../libraries/message.html>`_ provides for CSRF validation
184+
- `HTTP library </incoming/message.html>`_ provides for CSRF validation
185185

186186
**********************************************
187187
A9 Using Components with Known Vulnerabilities
@@ -217,6 +217,6 @@ OWASP recommendations
217217
CodeIgniter provisions
218218
----------------------
219219

220-
- `HTTP library <../libraries/message.html>`_ provides for ...
220+
- `HTTP library </incoming/message.html>`_ provides for ...
221221
- `Session <../libraries/sessions.html>`_ library provides flashdata
222222

user_guide_src/source/database/events.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
Database Events
33
###############
44

5-
The Database classes contain a few :doc:`Events </general/events>` that you can tap into in
5+
The Database classes contain a few :doc:`Events </extending/events>` that you can tap into in
66
order to learn more about what is happening during the database execution. These events can
7-
be used to collect data for analysis and reporting. The :doc:`Debug Toolbar </general/debugging>`
7+
be used to collect data for analysis and reporting. The :doc:`Debug Toolbar </testing/debugging>`
88
uses this to collect the queries to display in the Toolbar.
99

1010
==========

user_guide_src/source/database/index.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##################
2-
Database Reference
3-
##################
1+
######################
2+
Working With Databases
3+
######################
44

55
CodeIgniter comes with a full-featured and very fast abstracted database
66
class that supports both traditional structures and Query Builder
@@ -19,9 +19,4 @@ patterns. The database functions offer clear, simple syntax.
1919
Transactions <transactions>
2020
Getting MetaData <metadata>
2121
Custom Function Calls <call_function>
22-
Using CodeIgniter's Model <model>
23-
Using Entity Classes <entities>
24-
Database Manipulation with Database Forge <forge>
25-
Database Migrations <migration>
26-
Database Seeding <seeds>
2722
Database Events <events>

0 commit comments

Comments
 (0)