Skip to content

Commit e3dcd83

Browse files
authored
Merge pull request #6060 from codeigniter4/ug-packages
Add links to official packages.
2 parents 6b215f9 + b3e497d commit e3dcd83

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed

user_guide_src/source/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,12 @@ Advanced Topics
113113

114114
license
115115
changelogs/index
116+
117+
*****************
118+
Official Packages
119+
*****************
120+
121+
.. toctree::
122+
:titlesonly:
123+
124+
libraries/official_packages
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
#################
2+
Official Packages
3+
#################
4+
5+
The CodeIgniter framework cannot solve all of the problems that developers will encounter.
6+
Many users have said they love how small and fast the framework is, so we don't want to
7+
bloat the core framework. To bridge the gap we are releasing official packages to provide
8+
additional functionality that not every site will need or want.
9+
10+
.. contents::
11+
:local:
12+
:depth: 2
13+
14+
******
15+
Shield
16+
******
17+
18+
`CodeIgniter Shield <https://github.com/codeigniter4/shield>`_ is an authentication
19+
and authorization framework for CodeIgniter 4. It is designed to be secure, flexible,
20+
and easily extendable to meet the needs of many different types of websites.
21+
Among the many featues, it includes:
22+
23+
* Session-based authentication
24+
* Personal access token authentication
25+
* framework for after login/register "actions" (like Two Factor Authentication, etc)
26+
* Role-Based Access Control with simple, flexible permissions.
27+
* Per-user permission overrides,
28+
* and more...
29+
30+
********
31+
Settings
32+
********
33+
34+
`CodeIgniter Settings <https://github.com/codeigniter4/settings>`_ is a wrapper around
35+
the configuration files that allows any configuration setting to saved to the database,
36+
while defaulting to the config files when not custom value has been stored. This allows
37+
an application to ship with the default config values, but adapt as the project grows
38+
or moves servers, without having to touch the code.
39+
40+
41+
*****
42+
Cache
43+
*****
44+
45+
We provide a library with `PSR-6 and PSR-16 Cache Adapters <https://github.com/codeigniter4/cache>`_
46+
for CodeIgniter 4. This is not required for use, since CodeIgniter 4 comes with a fully-
47+
functional cache component. This module is only for integrating third-party packages
48+
that rely on the PSR interface provisions.
49+
50+
51+
******
52+
DevKit
53+
******
54+
55+
`CodeIgniter DevKit <https://github.com/codeigniter4/devkit>`_ provides all of the
56+
development tools that CodeIgniter uses to help ensure quality code, including
57+
our coding standard, static analysys tools and rules, unit testing, data generation,
58+
file-system mocking, security advisories, and more. This can be used in any of
59+
your personal projects or libraries to get you rapidly setup with 17 different tools.
60+
61+
62+
***************
63+
Coding Standard
64+
***************
65+
66+
The `CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard>`_
67+
holds the official coding standards of CodeIgniter based on PHP CS Fixer and powered by
68+
Nexus CS Config. This can be used in your own projects to form the basis of a
69+
consistent set of style rules that can be automatically applied to your code.

0 commit comments

Comments
 (0)