Skip to content

[Sync-En] Revise the Yaf extension documentation (#5809) - #1179

Merged
julionc merged 1 commit into
php:masterfrom
lacatoire:sync-en/1121-yaf
Sep 1, 2026
Merged

[Sync-En] Revise the Yaf extension documentation (#5809)#1179
julionc merged 1 commit into
php:masterfrom
lacatoire:sync-en/1121-yaf

Conversation

@lacatoire

Copy link
Copy Markdown
Member

Closes #1121

Sync with EN PR php/doc-en#5809 (commit ddcf673c59d1708557680946fbffeee361d7fca6).

Changes

  • Remove 17 duplicate method pages that only re-documented inherited methods (Yaf_Request_Http, Yaf_Request_Simple, Yaf_Application::__destruct, Yaf_Response_Abstract::__destruct)
  • Update EN-Revision header to ddcf673 for all 260 modified files
  • Add 11 new method pages: Yaf_Dispatcher::getResponse/setResponse, Yaf_Request_Abstract::get/getQuery/getPost/getFiles/getCookie/getRequest/getRaw, isDelete, isPatch

@lacatoire
lacatoire marked this pull request as ready for review August 31, 2026 12:58
Follow up on the Yaf rewrite in php/doc-en#5809: remove the 17 pages that
only re-documented inherited methods, add the 11 pages it introduced, and
bring the remaining pages in line with the English at ddcf673 (052c737e
for the three pages a later commit touched).

Every page is translated: the description, parameter and return blocks
that doc-en fills are filled here too, warn.undocumented.func is gone
from the pages that are now documented, and no block is left half in
English. Code comments and example strings are in Spanish, the outputs
match the code they follow, and the link targets mirror doc-en.

The overview pages were out of sync in ways the structure check cannot
see, since it stops at para: constants.xml documented none of the twelve
constants, was missing YAF_ERR_ACCESS_ERROR and listed
YAF_ERR_AUTOLOAD_FAILED out of order; ini.xml still documented
yaf.cache_config as a live directive while carrying the note saying it
was removed in Yaf 3.0.0; appconfig.xml had lost the Yaconf tip.

Several examples were stale or wrong and are fixed along the way:
Yaf_Route_Map::__construct had controller and action swapped in both
outputs, Yaf_Application::execute had lost the body of main() and its
output, Yaf_Dispatcher::registerPlugin was truncated before the closing
brace, Yaf_Response_Abstract::response called a translated method name,
Yaf_View_Simple::assignRef still described a bug fixed in Yaf 2.1.4,
Yaf_View_Simple::__construct used APPLICATOIN_PATH and a dropped option,
and Yaf_Route_Supervar::__construct documented another supervar than the
one its own example registered.

Terminology is unified across the extension: namespace, plugin,
renderizar and por omisión.

Also ignore /en, so a local doc-en checkout cannot be committed again.
@julionc
julionc merged commit be392ba into php:master Sep 1, 2026
4 checks passed
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.

[Sync EN] Revise the Yaf extension documentation (#5809)

2 participants