php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #33810 Documentation structure change
Submitted: 2005-07-21 20:31 UTC Modified: 2005-07-24 23:15 UTC
From: php at karsites dot net Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: Linux
Private report: No CVE-ID: None
 [2005-07-21 20:31 UTC] php at karsites dot net
Description:
------------
It it possible to split the PHP function reference into 
'core' extensions, and 'external' extensions. including 
those in PECL? 
 
I think this would make it alot easier for people to 
identify the functions that are part of th core PHP 
language - ie built-in to PHP directly. 
 
Keith Roberts 
 


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2005-07-21 20:38 UTC] goba@php.net
Most of the PHP users have some provider having a custom PHP setup with some additional extensions given and some configuration options tightened. It is important for our manual to be general, so that you don't need to think like: "ok, my provider has this extension, is it core or not?"

We are aware of this issue, and have an extension categorization item on our todo list, as well as an item to allow people to download customized manuals for their own needs, so we are not putting our heads in the sand, it is just that there is no such thing as core PHP, since the different hosting providers configure it differently.
 [2005-07-21 22:30 UTC] php at karsites dot net
By core PHP I mean the following type of function groups. 
 
XXXVIII. Filesystem Functions 
 
--snip-- 
 
Installation 
 
There is no installation needed to use these functions; 
they are part of the PHP core. 
 
XXXI. Error Handling and Logging Functions 
 
Introduction 
 
--snip-- 
 
These are functions dealing with error handling and 
logging. They allow you to define your own error handling 
rules, as well as modify the way the errors can be logged. 
This allows you to change and enhance error reporting to 
suit your needs. 
 
Requirements 
 
No external libraries are needed to build this extension. 
 
Installation 
 
There is no installation needed to use these functions; 
they are part of the PHP core. 
 
What I mean is the core PHP functions that the <PHP 
developers> consider as 'essential PHP functions', normally 
included and compiled into PHP, could be mentioned 
seperately in the PHP manual. 
 
If other parties distributing PHP want to leave these core 
components out of their distros, then that is up to them. 
 
HTH - Keith Roberts
 [2005-07-22 13:43 UTC] php at karsites dot net
Hi - I've been through the PHP manual, version 2005-07-06 
(Copyright ? 1997-2005 the PHP Documentation Group) 
 
and identified what appears to be a number of 'core 
functions'. By core functions, I take it these are always 
available, and cannot be removed using compile options. 
 
Please correct me if this is not the case. 
 
I have grouped these core functions together at; 
 
http://localhost/KAR/websites/pub/computing/php/functions/core/ 
 
and produced a core function 'quick-reference', in the 
relevant directory, that may be of interest. 
 
Regards - Keith Roberts
 [2005-07-22 14:03 UTC] richard dot quadling at bandvulc dot co dot uk
http://www.karsites.net/KAR/websites/pub/computing/php/functions/core/
 [2005-07-22 14:48 UTC] php at karsites dot net
Thanks Richard - LOL!
 [2005-07-22 18:12 UTC] php at karsites dot net
Some more suggestions for dividing the PHP Function 
Reference part of the manual, into various sub-headings. 
 
I have placed each extensions intro page into what I think 
would be a suitable category, or sub-heading. 
 
/BUNDLED/ 
 PHP extensions that are bundled with PHP, which can be 
enabled or disabled at compile time. 
 
/DATABASE/ 
 extensions that are pertinent to DB functionality. 
 
/DEPRECATED/ 
 extensions marked as deprecated. 
 
/EXPERIMENTAL/ 
 extensions marked as experimental. 
 
/EXTERNAL/ 
 extensions that are not bundled with php, and available  
from other providers, apart from PECL. 
 
/NOT_SURE/ 
 I'm not sure what category to place these extensions into. 
 
/PECL/ 
 extensions available from PECL, and possibly with more 
links to the authors website. 
 
/core/ 
 extensions that are a part of core PHP, and cannot be 
compiled out, with compilation options. 
 
I have not looked at the PHP source code, some of the above 
extensions may not be in the correct category - I just 
followed the details in the PHP manual. 
 
The above is just a suggestion as how the PHP manual may be 
organised in the future. Hopefully, this will allow 
developers to get their head around the PHP and the manual 
alot quicker. 
 
http://www.karsites.net/KAR/websites/pub/computing/php/functions/ 
 
HTH - KR
 [2005-07-24 22:10 UTC] vrana@php.net
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.

http://cvs.php.net/co.php/phpdoc/en/appendices/extensions.xml

Thanks for your work.
 [2005-07-24 23:15 UTC] php at karsites dot net
Your Welcome!
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved.
Last updated: Wed Jul 16 21:01:33 2025 UTC