Skip to content

Correction of caption of link to "option read_and_close"#1067

Closed
mildabre wants to merge 151 commits into
nette:masterfrom
mildabre:patch-24
Closed

Correction of caption of link to "option read_and_close"#1067
mildabre wants to merge 151 commits into
nette:masterfrom
mildabre:patch-24

Conversation

@mildabre

@mildabre mildabre commented Nov 7, 2024

Copy link
Copy Markdown
Contributor

The link to PHP documentation to session_start parameter option read_and_close should have caption with PHP naming convention, because "readAndClose" is convention in nette configuration and this could be confusing.

  • bug fix / new feature?
  • BC break? yes/no
  • doc PR: nette/docs#???

@dg dg force-pushed the master branch 29 times, most recently from e0bc7f4 to 3c92c82 Compare December 18, 2024 14:49
@dg

dg commented Jul 5, 2026

Copy link
Copy Markdown
Member

Thanks, I understand the concern, but I'm going to keep the caption as readAndClose — and here's why it's actually the correct one.

In a Nette config you write this key in camelCase: the schema in SessionExtension.php defines it literally as 'readAndClose' => Expect::bool(). So readAndClose is exactly what belongs in your NEON session: section, and it's consistent with the preceding note "(in camelCase format)". If we showed read_and_close instead, a reader could copy it into their config, where that key doesn't exist and wouldn't work.

The link merely points to the underlying PHP session_start() parameter for reference; Nette exposes it under the camelCase name. Closing for that reason — thanks for raising it though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.