Commit graph

114 commits

Author SHA1 Message Date
Greg Beaver
e90291b5fe document phar class constants
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260021 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-19 21:57:30 +00:00
Greg Beaver
094d944995 fix example to use convertToExecutable instead of
obsolete functionality


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260001 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-19 16:34:26 +00:00
Greg Beaver
75acc246a2 remove refs to non-existent functionality
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260000 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-19 16:33:31 +00:00
Greg Beaver
a04b081006 add note about using __FILE__ in a stub
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259949 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-18 22:59:31 +00:00
Greg Beaver
f3c6ee393f clarify stub example again to be correct.
Phar::running() returns \"\" in the stub


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259948 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-18 22:57:32 +00:00
Greg Beaver
b54a57860e fix Phar::running() usage
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259931 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-18 18:11:00 +00:00
Greg Beaver
699be46510 fix misleading include to match what a stub should look like
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259927 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-18 17:50:14 +00:00
Greg Beaver
4f08be019b fix typo in ID
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259916 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-18 15:06:33 +00:00
Greg Beaver
e5e4d5c043 document addition of whole-archive and per-file metadata for tar-based archives
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259820 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-15 23:50:08 +00:00
Greg Beaver
43e11396cd document removal of phar.extract_list
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259283 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-08 02:54:52 +00:00
Greg Beaver
93b337cdf4 document Phar::unlinkArchive
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258948 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-03 02:04:28 +00:00
Greg Beaver
5095f84b7d update docs to reflect phar refactoring of isTar/isZip/isPhar to isFileFormat
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258892 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-02 05:14:02 +00:00
Greg Beaver
d328869534 docs now match CVS of pecl/phar
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258887 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-02 04:36:22 +00:00
Greg Beaver
b1f43b0ddf add docs for addEmptyDir, addFromString, addFile
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258847 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-01 05:02:08 +00:00
Greg Beaver
64b5d43991 continue doc updating to current API
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258846 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-01 03:28:07 +00:00
Hannes Magnusson
08c916c42c fix type
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@257027 c90b9560-bf6c-de11-be94-00142212c4b1
2008-04-09 10:58:08 +00:00
Hannes Magnusson
35096430df Fix build
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@256057 c90b9560-bf6c-de11-be94-00142212c4b1
2008-03-25 15:36:13 +00:00
Greg Beaver
85c97f2f3a update phar docs to current API for 2.0 (still some work to do on modifying the compress\* methods of Phar)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@256055 c90b9560-bf6c-de11-be94-00142212c4b1
2008-03-25 14:04:25 +00:00
Greg Beaver
ab9294e481 remove reference to PharData, PharData methods will be documented separately
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@256044 c90b9560-bf6c-de11-be94-00142212c4b1
2008-03-25 03:35:32 +00:00
Greg Beaver
920bf84d32 correct typo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@256043 c90b9560-bf6c-de11-be94-00142212c4b1
2008-03-25 03:33:46 +00:00
Greg Beaver
695bfb0360 new docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255935 c90b9560-bf6c-de11-be94-00142212c4b1
2008-03-24 05:32:17 +00:00
Richard Quadling
4030c7e82d IDs of --construct => construct. Consistent with all other constructors.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@253821 c90b9560-bf6c-de11-be94-00142212c4b1
2008-02-26 13:30:05 +00:00
TAKAGI Masahiro
0af5f5b0c2 fixed the parameter of 'stream_context_create'.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251624 c90b9560-bf6c-de11-be94-00142212c4b1
2008-01-29 13:38:05 +00:00
TAKAGI Masahiro
3cd6d1522e fixed typo.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251623 c90b9560-bf6c-de11-be94-00142212c4b1
2008-01-29 13:36:50 +00:00
Greg Beaver
f45d3cb110 fix xml:id for methods, document webPhar, add xml:id to all <section>
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251096 c90b9560-bf6c-de11-be94-00142212c4b1
2008-01-21 21:54:18 +00:00
Greg Beaver
54f3bce0e6 update phar docs to version 2.0.0, s/Compression Extensions/Compression and Archive Extensions/
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251068 c90b9560-bf6c-de11-be94-00142212c4b1
2008-01-21 15:23:52 +00:00
Felipe Pena
6c9cf68f36 Fix example (begin and commit methods were renamed to startBuffering and stopBuffering)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249110 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-27 01:56:45 +00:00
Philip Olson
0a5a0d0fa7 MFB: Upgrade to the new-reference-structure
- Split reference.xml into book.xml, setup.xml
- Moved from reference.xml to book.xml:
  - The intro text (partintro), and link to various pages
- Moved from reference.xml to setup.xml:
  - The rest: requirements, installation, configuration, and resources
- Created a new constants.xml
- Changed using.xml and fileformat.xml to be chapters
- Changed the intro ID from <extname>.intro to intro.<extname>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248710 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-22 00:03:28 +00:00
Hannes Magnusson
0258a77f1e MFB: Rename "functions.xml" to entities.<dirname>.xml
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@247901 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-10 17:06:11 +00:00
Nuno Lopes
de383c4aab fully automatic update of the ini.xml files
please review this patch and notify me of any problems
PS: please review this :)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@243190 c90b9560-bf6c-de11-be94-00142212c4b1
2007-09-29 22:54:33 +00:00
Greg Beaver
34dc6a7496 fix incorrect documentation on phar.extract_list
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241923 c90b9560-bf6c-de11-be94-00142212c4b1
2007-08-30 03:28:24 +00:00
Hannes Magnusson
4c35a9a094 Document phar.extract-list
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@240599 c90b9560-bf6c-de11-be94-00142212c4b1
2007-08-02 15:07:22 +00:00
Gwynne Raskind
f5ea13bca2 Correct misuse of <link/>, correct small grammatical error, correct <refpurpose/>.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238993 c90b9560-bf6c-de11-be94-00142212c4b1
2007-07-02 05:41:27 +00:00
Hannes Magnusson
d104fb2aa9 Docbook5 typos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238235 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-21 23:09:03 +00:00
Hannes Magnusson
47babea5e9 More Docbook5 upgrades...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238171 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-21 00:43:30 +00:00
Hannes Magnusson
c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00
Jakub Vrana
75ecffb1cb Fix methodsynopsis
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237770 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-15 15:53:14 +00:00
Philip Olson
64e4c5dcab Updated the Purpose/Membership/State attributes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237600 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-14 01:24:35 +00:00
Greg Beaver
30d4974190 rename begin/isFlushingToPhar/commit to startBuffering/isBuffering/stopBuffering for simpler conception
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@232333 c90b9560-bf6c-de11-be94-00142212c4b1
2007-03-22 17:09:57 +00:00
Philip Olson
8bb5f00e92 markup
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@231956 c90b9560-bf6c-de11-be94-00142212c4b1
2007-03-16 02:16:04 +00:00
Philip Olson
009395cfbc Miscellaneous formatting as per our guidelines:
Ex: windows->Windows, commandline->command line, webserver->web server
# Sorry translators, but it needed to be done


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229834 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-15 09:24:37 +00:00
Greg Beaver
7c37eca28e update params for pending release
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229234 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-07 00:39:13 +00:00
Greg Beaver
158f520404 major update of all phar docs:
fix numerous small errors
fix missing documentation or large omissions
update references to API version to 1.0.0
add PharFileInfo->chmod()


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229102 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-06 05:46:41 +00:00
TAKAGI Masahiro
67e59a968c typo fix.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228832 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 06:43:04 +00:00
Greg Beaver
089fb1eb4e strtolower() all files and identifiers, fix a few minor problems found in the doc links too
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228827 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 05:16:53 +00:00
Greg Beaver
c63ddd8718 remove weird irrelevant trailing clause
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228824 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 04:16:12 +00:00
Greg Beaver
d990412daf consistency - use -> for all non-static methods
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228823 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 04:10:00 +00:00
Greg Beaver
79c0148c3a update docs to current CVS, fix a few mistakes discovered
encourage best practices in the examples for Phar objects.

These will match the first release of the phar extension, to
occur this week some time, so any cleaning that needs to be
done can be done now.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228818 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 04:03:09 +00:00
TAKAGI Masahiro
5ae9c97580 typo fix.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228817 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 03:55:05 +00:00
Jakub Vrana
abf7452cac Fix return type
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228399 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-29 09:56:10 +00:00
Greg Beaver
b75f1750f7 update to include Phar metadata
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228376 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-29 03:17:36 +00:00
Greg Beaver
a7f15583a9 don't encourage \" ?>\" after __HALT_COMPILER();
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228354 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 21:52:56 +00:00
Greg Beaver
831ba60a41 docs are complete now for phar
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228347 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 21:45:44 +00:00
Greg Beaver
a69f689899 update docs to current cvs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228329 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 20:08:52 +00:00
Greg Beaver
cbbee1057b fix doc example screen output (take )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228283 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 05:39:12 +00:00
Greg Beaver
aaeddc313f fix doc example screen output
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228282 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 05:37:51 +00:00
Greg Beaver
d60ca4547e fix doc example
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228281 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 05:36:47 +00:00
Greg Beaver
7dc7b75cb8 add docs for new functionality, update docs for old, fix a small typo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228280 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-28 05:31:52 +00:00
TAKAGI Masahiro
358d949115 fixed value of signature flag.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228170 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-26 20:59:14 +00:00
Greg Beaver
4257d89464 add documentation on the Phar file format
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228018 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-24 04:37:45 +00:00
Jakub Vrana
76c060d5d9 Return values
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227485 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-18 08:49:59 +00:00
Jakub Vrana
022bc73175 Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227484 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-18 08:45:26 +00:00
Greg Beaver
7c596ae88b remove functions.xml, add .cvsignore
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227469 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-18 00:25:44 +00:00
Greg Beaver
6a342aa5e1 initial docs for phar extension
# need sanity check, first time doing phpdoc


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227468 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-18 00:24:34 +00:00