PHP Wiki - doc:todo

changelog

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Changelog evaluation ===
	+	Each function/method has its own changelog. However, how they are written has introduced inconsistencies into the documentation.

	+	=== TODO ===
	+	Determine the official route for:
	+	* Order: Do newest PHP versions go on top or bottom?
	+	* Format: Is it PHP 5, 5, 5.0, or 5.0.0?
	+	* Information: Would the documentation make sense without the changelog entries? It should.
	+
	+	Next, evaluate each changelog and ensure it adheres to our official scheme.
	+
	+	And lastly, document this scheme within the HOWTO.

gitdocs

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2020/02/04 12:53		current
Line 10:		Line 10:
	* Assigned: Peter		* Assigned: Peter
	- Grant force-push access to a user that can push the modified commits from svngit.php.net (can be me, can be a dedicated user)		- Grant force-push access to a user that can push the modified commits from svngit.php.net (can be me, can be a dedicated user)
-	* Status: TODO	+	* Create a new VCS account for the migration
-	* Assigned: Peter	+	* Status: TODO
		+	* Assigned: Peter
		+	* Force-push should be allowed by default (AFAIK (Peter) we only restrict force-push to a very small set of branches on a very small number of repos)
		+	* Status: to be verified
		+	* Assigned: Peter
	- Add the remotes to the respective repos on svngit.php.net and set up automated force push		- Add the remotes to the respective repos on svngit.php.net and set up automated force push
	* Status: TODO		* Status: TODO

gwynne

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2009/08/05 13:07		current
Line 1:		Line 1:
	* Complete Zend Engine 2 documentation		* Complete Zend Engine 2 documentation
	* Write Zend Engine 3 documentation (Unicode support)		* Write Zend Engine 3 documentation (Unicode support)
-	* Write SAPI documentation (would resolve [[http://bugs.php.net/bug.php?id=10528\|#10528]])	+	* Write SAPI documentation

include

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Include() docs rewrite ===
	+	The documentation for include() is rather messy and needs simplification. This is perhaps the most common construct used in PHP and should be treated as such.

	+	=== Notes ===
	+	The require() and _once() documentation all refer to include(), and this is good.
	+
	+	=== TODO ===
	+	Evaluate the page, and rewrite.

inicleanup

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/04/06 10:59		current
Line 8:		Line 8:
	* php.ini files		* php.ini files
	* Each extension (has its own ini section)		* Each extension (has its own ini section)
-	* phpdoc/scripts/iniupdate	+	* phpdoc/scripts/iniupdate : this is no longer used, really, so we should make a final decision. Update it, or remove it.
		+	* There should be a single location that pulls in ALL ini information, from all extensions, so a person can easily ^f.

	=== Problems ===		=== Problems ===

install

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Installation section rewrite ===
	+	This task involves rewriting and restructuring the installation section of the PHP Manual. This is a large task so may be broken up into smaller parts.

	+	The section in question:
	+	* URL: http://php.net/install
	+	* Source: http://cvs.php.net/viewvc.cgi/phpdoc/en/install/
	+
	+	=== Problems ===
	+	This section has become outdated. For example, we highlight Apache 2.0.x and only include a few notes about Apache 2.2.x. There are a ton of user notes from confused users that should be addressed. The IIS/PWS section is outdated. The Mac section is outdated. Other parts, outdated.
	+
	+	=== TODO ===
	+	Start work on this one section at a time.

installrole

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Installation section rewrite ===
	+	Each extension has its own configuration and installation section, and these sections don't really follow a standard. We need a standard.
	+
	+	=== OS ===
	+	The main issue is Windows versus Unix. Currently this is done in many ways so it's rather confusing.
	+
	+	For details, see: http://markmail.org/message/c7hz3yycg4mvyje5
	+
	+	=== PECL ===
	+	Whether or not an extension is in PECL is another issue, as is worrying about if it moved to or from PHP core.
	+
	+	=== TODO ===
	+	Essentially this task involves three steps.
	+
	+	* Evaluate the current situation
	+	* Propose a format that each extension will use
	+	* Implement

kalle

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2010/01/08 21:11		current
Line 1:		Line 1:
	==== Kalle's TODO bin ====		==== Kalle's TODO bin ====

-	* <del>Close [[bugid@43728]]</del>	+	Empty ;o
-	* <del>Close [[bugid@44155]]</del>	+
-	* <del>Close [[bugid@46183]]</del>	+
-	* <del>Merge updated PECL Installation on Windows patch into cvs</del>	+
-	* <del>Add a couple of examples for touch() and stat functions</del>	+
-	* <del>Add usage examples for remaining functions in GD</del>	+
-	* <del>Missing description for imageftbbox below prototype</del>	+

logdownloads

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/04/06 10:59		current
Line 43:		Line 43:

	=== Notes ===		=== Notes ===
-	It would be helpful to determine and document exactly how our download system works. For example, a 404 handler sees /get/ then ...	+	It would be helpful to determine and document exactly how our download system works. For example, a 404 handler sees /get/ then ... ?

migrationguide

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2017/11/29 22:30		current
Line 197:		Line 197:
	* PCRE:		* PCRE:
	* Added `PREG_UNMATCHED_AS_NULL` flag to allow distinguish between unmatched subpatterns and empty matches by reporting NULL and "" (empty string), respectively.		* Added `PREG_UNMATCHED_AS_NULL` flag to allow distinguish between unmatched subpatterns and empty matches by reporting NULL and "" (empty string), respectively.
-	* Standard Library
-	* mail()/mb_send_mail() accept array $extra_header. Array parameter is checked against RFC 2822.


Line 206:		Line 204:
	* mb_check_encoding() accepts array parameter. Both key and value encodings are checked recursively.		* mb_check_encoding() accepts array parameter. Both key and value encodings are checked recursively.
	* mb_convert_encoding() accepts array parameter. Only value encodings are converted recursively.		* mb_convert_encoding() accepts array parameter. Only value encodings are converted recursively.
		+	* Standard Library
		+	* mail()/mb_send_mail() accept array $extra_header. Array parameter is checked against RFC 2822.
	* Windows		* Windows
	* Support for VT100 console mode on systems starting with Windows NT 10.0.10586 (Windows 10 (TH2)), cmd.exe supports ANSI escape sequences. The corresponding console mode is enabled by default on CLI on suitable systems. As well, the function sapi_windows_vt100_support() is provided, to control and query the corresponding information in the scripts.		* Support for VT100 console mode on systems starting with Windows NT 10.0.10586 (Windows 10 (TH2)), cmd.exe supports ANSI escape sequences. The corresponding console mode is enabled by default on CLI on suitable systems. As well, the function sapi_windows_vt100_support() is provided, to control and query the corresponding information in the scripts.

missingdocs

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2010/04/01 05:09		current
Line 14:		Line 14:
	* Look over our old version of this from the [[http://www.phpdoc.info/meta/phpsrc-vs-phpdoc.php\|old site]]		* Look over our old version of this from the [[http://www.phpdoc.info/meta/phpsrc-vs-phpdoc.php\|old site]]
	* Look over scripts/ to see what other nuggets can be found to help this task		* Look over scripts/ to see what other nuggets can be found to help this task
		+
		+	=== Solutions ===
		+	* The [[http://svn.php.net/viewvc/phpdoc/doc-base/trunk/scripts/check-missing-docs.php\|check-missing-docs.php]] script is a start

move_return_types_in_prototypes

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2017/11/15 09:17		current
Line 3:		Line 3:
	* Date: 2017-11-15		* Date: 2017-11-15
	* Author: salathe		* Author: salathe
-	* Status: draft	+	* Status: DONE

	===== Motivation =====		===== Motivation =====

mysqlnd_vs_libmysql

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/09/08 14:41		current
Line 28:		Line 28:


		+	Please make sure that you are using a PHP build with Zlib and OpenSSL support when switching from libmysql to mysqlnd. This will ensure that mysqlnd offers the same functionality as libmysql does.
	==== Major feature differences ====		==== Major feature differences ====

peehaa

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	I've created this list to keep track of things I would like to see changed in the docs.

	+	=== Work in progress ===
	+
	+	I'm currently working on [[http://php.net/tut.php\|the tutorial]], because it its current state it really isn't that useful. There is still a lot of work that needs to be done, but progress can be tracked on [[https://github.com/PeeHaa/php-net-tutorial\|GitHub]]. Feel free to review / improve it.
	+
	+	=== todo ===
	+
	+	* Write tutorial
	+	* [[http://www.php.net/manual/en/language.variables.external.php\|External variables]], the note about escaping data to safely do data manipulation in databases is not up to standards.
	+	* [[http://php.net/manual/en/debugger.php\|Debugging]], it would be nice if it would contain some useful information about how to do some basic debugging in PHP applications.
	+	* [[http://php.net/manual/en/security.database.sql-injection.php\|SQL Injection]], don't even get me started about this one.
	+	* [[http://php.net/manual/en/language.variables.scope.php\|Variable scoping]], do we really need to promote the use of the `global` keyword or the `$_GLOBALS` superglobal without any warning?
	+	* [[http://www.php.net/manual/en/userlandnaming.tips.php\|Userland naming]], really nice tips going on here ;-)
	+	* [[http://php.net/manual/en/pdostatement.fetch.php\|PDOStatement::fetch examples]], make the example better readable when possible.

per-release-all

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/06/20 03:41		current
Line 9:		Line 9:
	$ cd svn/phpdoc/trunk		$ cd svn/phpdoc/trunk
	$ xmllint --output tmp.xml --noent doc-base/install-unix.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > INSTALL		$ xmllint --output tmp.xml --noent doc-base/install-unix.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > INSTALL
-	$ xmllint --output tmp.xml --noent doc-base/install-windows.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > install.txt	+	$ xmllint --output tmp.xml --noent doc-base/install-win.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > install.txt
	</code>		</code>

per-release-major

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	==== TODO for every major (X.0.0) PHP Release ====
	+
	+	== Check version information ==
	+	Since each major PHP version is stored in the version files, this is taken into account at this time.
	+
	+	== Consider removing old information ==
	+	For example, is PHP 3 still relevant? How about PHP 4? If using version specific tagging, does the build system need adjusting?
	+
	+	== Update PHP version specific info ==
	+	The following manual pages contain version specific information that needs updating:
	+	* [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/about.xml?view=log\|appendices/about.xml]]

per-release-minor

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	==== TODO for every minor (x.Y.0) release ====
	+
	+	== Migration guides ==
	+	Since PHP 5.1.0, every such release has included a migration appendix / upgrade guide. This involves the following:
	+
	+	* php-src/README.UPDATE_X_Y (Examples: [[http://cvs.php.net/viewvc.cgi/phpweb/README_UPGRADE_51.php?hideattic=0\|5.1]], [[http://cvs.php.net/viewvc.cgi/php-src/README.UPDATE_5_2?&pathrev=PHP_5_2\|5.2]])
	+	* phpdoc/appendix/migrationXY.xml (Examples: [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/migration51.xml?view=log\|5.2]], [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/migration52.xml?view=log\|5.2]])
	+
	+	Currently the internals team has created the README files, but this may change.
	+
	+	== Extension categories ==
	+	Some extensions may have been moved to PECL, became bundled, were re-categorized, etc. This information should be updated at this time, or at any time before:
	+	* The XML: [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/extensions.xml?view=log\|phpdoc/en/appendices/extensions.xml]]
	+	* The script that updates it: [[http://cvs.php.net/viewvc.cgi/phpdoc/scripts/extensions.xml.php?view=log\|phpdoc/scripts.extensions.xml.php]]
	+	NOTE: This information comes from the comments found within (on top of) every book.xml. Status, and Membership. The Purpose dictates how the extensions are categorized in the index/table of contents.

phd

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/07/10 00:51		current
Line 16:		Line 16:
	* Add API to docs.php.net		* Add API to docs.php.net
	* Add PDF and other formats to [[http://doc.php.net/downloads]]		* Add PDF and other formats to [[http://doc.php.net/downloads]]
-	* Create QA tools based on PhD_IDE (e.g., find all 5.3.0+ changelog entries, find non-initialized optional params, find most common seealso links, php -l examples and create unit tests, find X, ...	+	* Create QA tools based on PhD_IDE (e.g., find all 5.3.0+ changelog entries, find non-initialized optional params, find most common seealso links, php -l examples and create unit tests, find X, ...)

	==== Big wishes ====		==== Big wishes ====

philip

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2012/01/08 06:04		current
Line 5:		Line 5:
	* ext/mysql/migration should exist, with mysqli+PDO_MySQL examples		* ext/mysql/migration should exist, with mysqli+PDO_MySQL examples

		+	PHP.NET update:
		+	* mysql->mysqli migration, where appropriate. Begin with master.

	=== Notes about this TODO ===		=== Notes about this TODO ===

php5rewrite

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Making PHP 5 a first class citizen rewrite ===
	+	This task rewords the manual in such a manner that PHP 5 becomes a first class citizen. This means we'll remove terms like:
	+
	+	* //As of PHP 5//
	+	* //Since PHP 5//
	+	* //Added in PHP 5//
	+
	+	Because those suggest that PHP 4 is the current PHP version, when in fact it's not.
	+
	+	The original proposal (and discussion that followed):
	+
	+	* http://markmail.org/message/vtxwpxutxtudhym7
	+
	+	This idea does not mean that we'd remove PHP 4 specific content. However, it does mean adding changelogs to various parts of the documentation.
	+
	+	=== Problems ===
	+
	+	=== TODO ===
	+	* Determine how this would work exactly
	+	* Determine how PHP 4 specific extensions, like the old domxml, would be handled

ross

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2008/11/01 20:40		current
Line 4:		Line 4:
	Working on further documenting the [[http://docs.php.net/datetime/\|datetime]] reference.		Working on further documenting the [[http://docs.php.net/datetime/\|datetime]] reference.

-	- [[http://uvshock.co.uk/DateTimeTodo.txt\|Todo List]]	+	- [[http://uvshock.co.uk/DateTimeTodo.txt\|Todo List]]

	=== Other Tasks ===		=== Other Tasks ===

rsync_doc_build_migration

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	=== Move doc builds off the rsync machine ===
	+	This task involves moving the doc builds off of the rsync machine, and instead using docs.php.net to build, which are then pushed to rsync for mirror distribution.

	+	* Probably pushed weekly
	+	* Remember the sqlite index script
	+	* Consider phd stable vs phd trunk for builds
	+	* Be sure the build isn't broken before pushing to rsync
	+	* Be sure the appropriate files are pushed

spldocs

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2010/03/16 11:43		current
Line 10:		Line 10:
	Some example areas to consider:		Some example areas to consider:

-	* Common Iterator methods: current, key, next, rewind, valid	+	* Common Iterator methods: current, key, next, rewind, valid
-	* OuterIterator interface: getInnerIterator	+	* OuterIterator interface: getInnerIterator
-	* Classes implementing Countable, RecursiveIterator, SeekableIterator	+	* Classes implementing Countable, RecursiveIterator, SeekableIterator
-	* What about non-SPL interfaces (e.g. ArrayAccess, Serializable)	+	* What about non-SPL interfaces (e.g. ArrayAccess, Serializable)

	Much of the remaining 'skeleton' SPL docs fall into this category of common methods so it would be worth having a plan of action on this subject before ploughing ahead with those.		Much of the remaining 'skeleton' SPL docs fall into this category of common methods so it would be worth having a plan of action on this subject before ploughing ahead with those.

translations

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2014/04/06 09:29		current
Line 12:		Line 12:
	==== Additional resources ====		==== Additional resources ====
	* The [[http://doc.php.net/revcheck.php\|revision check tools]]		* The [[http://doc.php.net/revcheck.php\|revision check tools]]
-	* The [[http://doc.php.net/dochowto/\|documentation HOWTO]]	+	* The [[http://doc.php.net/tutorial/\|documentation HOWTO]]

undocumented

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2010/01/08 21:11		current
Line 124:		Line 124:
	* ''Closures''		* ''Closures''
	===== PHP 5.x ====		===== PHP 5.x ====
		+	* SplObjectStorage::getHash
	* Type hints: ''self'', ''parent'' and interfaces.		* Type hints: ''self'', ''parent'' and interfaces.
	<code php>		<code php>

yearly

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/18 06:58	current
Line 1:	Line 1:
	+	==== TODO to begin each calendar year ====

	+	== License years ==
	+	The main update, important places to check:
	+	* phpdoc/scripts
	+	* phpdoc/
	+	* docweb/
	+	* phd/