Skip to content

Commit 17cd47c

Browse files
authored
Merge pull request #8515 from kenjis/docs-Config/App.php
docs: update Config\App comments
2 parents 06687e5 + bf1057e commit 17cd47c

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

app/Config/App.php

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ class App extends BaseConfig
1414
* URL to your CodeIgniter root. Typically, this will be your base URL,
1515
* WITH a trailing slash:
1616
*
17-
* http://example.com/
17+
* E.g., http://example.com/
1818
*/
1919
public string $baseURL = 'http://localhost:8080/';
2020

2121
/**
2222
* Allowed Hostnames in the Site URL other than the hostname in the baseURL.
2323
* If you want to accept multiple Hostnames, set this.
2424
*
25-
* E.g. When your site URL ($baseURL) is 'http://example.com/', and your site
26-
* also accepts 'http://media.example.com/' and
27-
* 'http://accounts.example.com/':
28-
* ['media.example.com', 'accounts.example.com']
25+
* E.g.,
26+
* When your site URL ($baseURL) is 'http://example.com/', and your site
27+
* also accepts 'http://media.example.com/' and 'http://accounts.example.com/':
28+
* ['media.example.com', 'accounts.example.com']
2929
*
3030
* @var list<string>
3131
*/
@@ -36,9 +36,9 @@ class App extends BaseConfig
3636
* Index File
3737
* --------------------------------------------------------------------------
3838
*
39-
* Typically this will be your index.php file, unless you've renamed it to
40-
* something else. If you are using mod_rewrite to remove the page set this
41-
* variable so that it is blank.
39+
* Typically, this will be your `index.php` file, unless you've renamed it to
40+
* something else. If you have configured your web server to remove this file
41+
* from your site URIs, set this variable to an empty string.
4242
*/
4343
public string $indexPage = 'index.php';
4444

@@ -48,12 +48,12 @@ class App extends BaseConfig
4848
* --------------------------------------------------------------------------
4949
*
5050
* This item determines which server global should be used to retrieve the
51-
* URI string. The default setting of 'REQUEST_URI' works for most servers.
51+
* URI string. The default setting of 'REQUEST_URI' works for most servers.
5252
* If your links do not seem to work, try one of the other delicious flavors:
5353
*
54-
* 'REQUEST_URI' Uses $_SERVER['REQUEST_URI']
55-
* 'QUERY_STRING' Uses $_SERVER['QUERY_STRING']
56-
* 'PATH_INFO' Uses $_SERVER['PATH_INFO']
54+
* 'REQUEST_URI': Uses $_SERVER['REQUEST_URI']
55+
* 'QUERY_STRING': Uses $_SERVER['QUERY_STRING']
56+
* 'PATH_INFO': Uses $_SERVER['PATH_INFO']
5757
*
5858
* WARNING: If you set this to 'PATH_INFO', URIs will always be URL-decoded!
5959
*/
@@ -94,7 +94,7 @@ class App extends BaseConfig
9494
*
9595
* IncomingRequest::setLocale() also uses this list.
9696
*
97-
* @var string[]
97+
* @var list<string>
9898
*/
9999
public array $supportedLocales = ['en'];
100100

@@ -106,7 +106,8 @@ class App extends BaseConfig
106106
* The default timezone that will be used in your application to display
107107
* dates with the date helper, and can be retrieved through app_timezone()
108108
*
109-
* @see https://www.php.net/manual/en/timezones.php for list of timezones supported by PHP.
109+
* @see https://www.php.net/manual/en/timezones.php for list of timezones
110+
* supported by PHP.
110111
*/
111112
public string $appTimezone = 'UTC';
112113

@@ -130,7 +131,7 @@ class App extends BaseConfig
130131
* If true, this will force every request made to this application to be
131132
* made via a secure connection (HTTPS). If the incoming request is not
132133
* secure, the user will be redirected to a secure version of the page
133-
* and the HTTP Strict Transport Security header will be set.
134+
* and the HTTP Strict Transport Security (HSTS) header will be set.
134135
*/
135136
public bool $forceGlobalSecureRequests = false;
136137

0 commit comments

Comments
 (0)