Skip to content

docs: fix sessions.rst #7586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 3 commits into from
Jun 18, 2023
Merged

docs: fix sessions.rst #7586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aaf95af
docs: update old session config names
kenjis Jun 17, 2023
855d528
docs: add "// ..." in sample code
kenjis Jun 17, 2023
fb269be
docs: fix letter upper/lower cases
kenjis Jun 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions user_guide_src/source/libraries/sessions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ but does not take any configuration options.

.. literalinclude:: sessions/002.php

How do Sessions work?
How Do Sessions Work?
=====================

When a page is loaded, the session class will check to see if a valid
Expand All @@ -59,7 +59,7 @@ automatic.
.. note:: Under CLI, the Session library will automatically halt itself,
as this is a concept based entirely on the HTTP protocol.

A note about concurrency
A Note about Concurrency
------------------------

Unless you're developing a website with heavy AJAX usage, you can skip this
Expand Down Expand Up @@ -435,7 +435,7 @@ Preference Default Opti
unexpected results or be changed in the future. Please configure
everything properly.

.. note:: If ``sessionExpiration`` is set to ``0``, the ``session.gc_maxlifetime``
.. note:: If ``expiration`` is set to ``0``, the ``session.gc_maxlifetime``
setting set by PHP in session management will be used as-is
(often the default value of ``1440``). This needs to be changed in
``php.ini`` or via ``ini_set()`` as needed.
Expand Down Expand Up @@ -597,10 +597,10 @@ For PostgreSQL::
You will also need to add a PRIMARY KEY **depending on your $matchIP
setting**. The examples below work both on MySQL and PostgreSQL::

// When sessionMatchIP = true
// When $matchIP = true
ALTER TABLE ci_sessions ADD PRIMARY KEY (id, ip_address);

// When sessionMatchIP = false
// When $matchIP = false
ALTER TABLE ci_sessions ADD PRIMARY KEY (id);

// To drop a previously created primary key (use when changing the setting)
Expand All @@ -627,7 +627,7 @@ RedisHandler Driver

.. note:: Since Redis doesn't have a locking mechanism exposed, locks for
this driver are emulated by a separate value that is kept for up
to 300 seconds. With ``v4.3.2`` or above, You can connect ``Redis`` with **TLS** protocol.
to 300 seconds. With ``v4.3.2`` or above, you can connect ``Redis`` with **TLS** protocol.

Redis is a storage engine typically used for caching and popular because
of its high performance, which is also probably your reason to use the
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/libraries/sessions/040.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ class Session extends BaseConfig
{
// ...
public ?string $DBGroup = 'groupName';

// ...
}