diff --git a/reference/phar/Phar/addEmptyDir.xml b/reference/phar/Phar/addEmptyDir.xml index 68221310e5..94f5db967f 100644 --- a/reference/phar/Phar/addEmptyDir.xml +++ b/reference/phar/Phar/addEmptyDir.xml @@ -1,6 +1,6 @@ - + Phar::addEmptyDir Add an empty directory to the phar archive @@ -9,7 +9,7 @@ &reftitle.description; public voidPhar::addEmptyDir - stringdirname + stringdirectory &phar.write; @@ -24,7 +24,7 @@ - dirname + directory The name of the empty directory to create in the phar archive @@ -79,7 +79,6 @@ try { - - + Phar::addFile Add a file from the filesystem to the phar archive @@ -9,14 +9,14 @@ &reftitle.description; public voidPhar::addFile - stringfile - stringlocalname + stringfilename + stringnulllocalName&null; &phar.write; With this method, any file or URL can be added to the phar archive. If - the optional second parameter localname is specified, + the optional second parameter localname is a &string;, the file will be stored in the archive with that name, otherwise the file parameter is used as the path to store within the archive. URLs must have a localname or an exception is thrown. @@ -29,7 +29,7 @@ - file + filename Full or relative path to a file on disk to be added @@ -38,7 +38,7 @@ - localname + localName Path that the file will be stored in the archive. @@ -56,6 +56,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + localName is now nullable. + + + + + + + &reftitle.examples; @@ -105,7 +127,6 @@ try { - - + Phar::addFromString Add a file from a string to the phar archive @@ -9,7 +9,7 @@ &reftitle.description; public voidPhar::addFromString - stringlocalname + stringlocalName stringcontents &phar.write; @@ -26,7 +26,7 @@ - localname + localName Path that the file will be stored in the archive. @@ -99,7 +99,6 @@ try { - - + Phar::canCompress Returns whether phar extension supports compression using either zlib or bzip2 @@ -9,7 +9,7 @@ &reftitle.description; final public static boolPhar::canCompress - inttype0 + intcompression0 @@ -23,7 +23,7 @@ - type + compression Either Phar::GZ or Phar::BZ2 can be @@ -82,7 +82,6 @@ if (Phar::canCompress()) { - - + Phar::compress Compresses the entire Phar archive using Gzip or Bzip2 compression @@ -9,9 +9,9 @@ &reftitle.description; - public PharPhar::compress + public PharnullPhar::compress intcompression - stringextension + stringnullextension&null; &phar.write; @@ -71,7 +71,7 @@ &reftitle.returnvalues; - Returns a Phar object. + Returns a Phar object, or &null; on failure. @@ -86,6 +86,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + extension is now nullable. + + + + + + + &reftitle.examples; @@ -127,7 +149,6 @@ $p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.phar already exists - - + Phar::count Returns the number of entries (files) in the Phar archive @@ -9,7 +9,7 @@ &reftitle.description; public intPhar::count - + intmodeCOUNT_NORMAL @@ -64,7 +64,6 @@ The new phar has 1 entries - - + Phar::createDefaultStub Create a phar-file format specific stub @@ -9,8 +9,8 @@ &reftitle.description; final public static stringPhar::createDefaultStub - stringindex - stringwebIndex + stringnullindex&null; + stringnullwebIndex&null; @@ -89,6 +89,28 @@ php myphar.phar + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + index and webIndex are now nullable. + + + + + + + &reftitle.examples; @@ -122,7 +144,6 @@ try { - - + Phar::decompress Decompresses the entire Phar archive @@ -9,8 +9,8 @@ &reftitle.description; - public PharPhar::decompress - stringextension + public PharnullPhar::decompress + stringnullextension&null; &phar.write; @@ -60,7 +60,7 @@ &reftitle.returnvalues; - A Phar object is returned. + A Phar object is returned on success, and &null; on failure. @@ -75,6 +75,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + extension is now nullable. + + + + + + + &reftitle.examples; @@ -114,7 +136,6 @@ $p3 = $p2->decompress(); // creates /path/to/my.phar - - Phar::getAlias @@ -10,8 +9,8 @@ &reftitle.description; - public stringPhar::getAlias - + public stringnullPhar::getAlias + @@ -35,7 +34,6 @@ - - + Phar::getMetadata Returns phar archive meta-data @@ -9,7 +9,7 @@ &reftitle.description; public mixedPhar::getMetadata - + arrayunserializeOptions[] @@ -26,7 +26,7 @@ &reftitle.returnvalues; - any PHP variable that can be serialized and is stored as meta-data for the Phar archive, + Any PHP value that can be serialized and is stored as meta-data for the Phar archive, or &null; if no meta-data is stored. @@ -79,7 +79,6 @@ array(1) { - - + Phar::getSignature Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive @@ -8,7 +8,7 @@ &reftitle.description; - public arrayPhar::getSignature + public arrayfalsePhar::getSignature @@ -33,12 +33,12 @@ A valid signature is absolutely required of all executable phar archives if the phar.require_hash INI variable is set to true. + If there is no signature, the function returns &false;. - - + Phar::loadPhar Loads any phar archive with an alias @@ -10,7 +10,7 @@ final public static boolPhar::loadPhar stringfilename - stringalias + stringnullalias&null; @@ -97,7 +97,6 @@ try { - - + Phar::mapPhar Reads the currently executed file (a phar) and registers its manifest @@ -9,8 +9,8 @@ &reftitle.description; final public static boolPhar::mapPhar - stringalias - intdataoffset0 + stringnullalias&null; + intoffset0 @@ -34,7 +34,7 @@ - dataoffset + offset Unused variable, here for compatibility with PEAR's PHP_Archive. @@ -104,7 +104,6 @@ __HALT_COMPILER(); - - + Phar::offsetExists Determines whether a file exists in the phar @@ -9,7 +9,7 @@ &reftitle.description; public boolPhar::offsetExists - stringoffset + stringlocalName This is an implementation of the ArrayAccess interface allowing @@ -26,7 +26,7 @@ - offset + localName The filename (relative path) to look for in a Phar. @@ -83,7 +83,6 @@ bool(false) - - + Phar::offsetGet Gets a PharFileInfo object for a specific file @@ -9,7 +9,7 @@ &reftitle.description; public PharFileInfoPhar::offsetGet - stringoffset + stringlocalName @@ -25,7 +25,7 @@ - offset + localName The filename (relative path) to look for in a Phar. @@ -99,7 +99,6 @@ Entry doesnotexist.txt does not exist - - + Phar::offsetSet Set the contents of an internal file to those of an external file @@ -9,8 +9,8 @@ &reftitle.description; public voidPhar::offsetSet - stringoffset - stringvalue + stringlocalName + resourcestringvalue &phar.write; @@ -28,7 +28,7 @@ - offset + localName The filename (relative path) to modify in a Phar. @@ -108,7 +108,6 @@ try { - - + Phar::offsetUnset Remove a file from a phar @@ -9,7 +9,7 @@ &reftitle.description; public boolPhar::offsetUnset - stringoffset + stringlocalName &phar.write; @@ -29,7 +29,7 @@ - offset + localName The filename (relative path) to modify in a Phar. @@ -94,7 +94,6 @@ try { - - + Phar::setDefaultStub Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader @@ -9,8 +9,8 @@ &reftitle.description; public boolPhar::setDefaultStub - stringindex - stringwebindex + stringnullindex&null; + stringnullwebIndex&null; &phar.write; @@ -32,7 +32,7 @@ - webindex + webIndex Relative path within the phar archive to run if accessed through a web browser @@ -61,6 +61,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + webIndex is nullable now. + + + + + + + &reftitle.examples; @@ -97,7 +119,6 @@ try { - diff --git a/reference/phar/PharData/addEmptyDir.xml b/reference/phar/PharData/addEmptyDir.xml index 6f50ff8bb3..0ce43cdcc4 100644 --- a/reference/phar/PharData/addEmptyDir.xml +++ b/reference/phar/PharData/addEmptyDir.xml @@ -1,6 +1,6 @@ - + PharData::addEmptyDir Add an empty directory to the tar/zip archive @@ -9,7 +9,7 @@ &reftitle.description; public voidPharData::addEmptyDir - stringdirname + stringdirectory @@ -23,7 +23,7 @@ - dirname + directory The name of the empty directory to create in the phar archive @@ -78,7 +78,6 @@ try { - - + PharData::addFile Add a file from the filesystem to the tar/zip archive @@ -9,8 +9,8 @@ &reftitle.description; public voidPharData::addFile - stringfile - stringlocalname + stringfilename + stringnulllocalName&null; @@ -28,7 +28,7 @@ - file + filename Full or relative path to a file on disk to be added @@ -37,7 +37,7 @@ - localname + localName Path that the file will be stored in the archive. @@ -54,6 +54,28 @@ no return value, exception is thrown on failure. + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + localName is now nullable. + + + + + + &reftitle.examples; @@ -104,7 +126,6 @@ try { - - + PharData::addFromString Add a file from the filesystem to the tar/zip archive @@ -9,7 +9,7 @@ &reftitle.description; public voidPharData::addFromString - stringlocalname + stringlocalName stringcontents @@ -25,7 +25,7 @@ - localname + localName Path that the file will be stored in the archive. @@ -98,7 +98,6 @@ try { - - + PharData::compress Compresses the entire tar/zip archive using Gzip or Bzip2 compression @@ -9,9 +9,9 @@ &reftitle.description; - public PharDataPharData::compress + public PharnullPharData::compress intcompression - stringextension + stringnullextension&null; @@ -65,7 +65,8 @@ &reftitle.returnvalues; - A PharData object is returned. + A PharData object is returned on success, + or &null; on failure. @@ -79,6 +80,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + extension is now nullable. + + + + + + + &reftitle.examples; @@ -110,7 +133,6 @@ $p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.tar already exists - - + PharData::decompress Decompresses the entire Phar archive @@ -9,8 +9,8 @@ &reftitle.description; - public PharDataPharData::decompress - stringextension + public PharnullPharData::decompress + stringnullextension&null; @@ -30,8 +30,7 @@ parameter. - - + &reftitle.parameters; @@ -49,13 +48,13 @@ - &reftitle.returnvalues; - A PharData object is returned. + A PharData object is returned on success, + or &null; on failure. @@ -69,6 +68,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + extension is now nullable. + + + + + + + &reftitle.examples; @@ -106,7 +127,6 @@ $p->decompress(); // creates /path/to/my.tar - - + PharData::offsetSet Set the contents of a file within the tar/zip to those of an external file or string @@ -9,8 +9,8 @@ &reftitle.description; public voidPharData::offsetSet - stringoffset - stringvalue + stringlocalName + resourcestringvalue @@ -27,7 +27,7 @@ - offset + localName The filename (relative path) to modify in a tar or zip archive. @@ -103,7 +103,6 @@ try { - - + PharData::offsetUnset Remove a file from a tar/zip archive @@ -9,7 +9,7 @@ &reftitle.description; public boolPharData::offsetUnset - stringoffset + stringlocalName @@ -28,7 +28,7 @@ - offset + localName The filename (relative path) to modify in the tar/zip archive. @@ -87,7 +87,6 @@ try { - - + PharData::setDefaultStub Dummy function (Phar::setDefaultStub is not valid for PharData) @@ -9,8 +9,8 @@ &reftitle.description; public boolPharData::setDefaultStub - stringindex - stringwebindex + stringnullindex&null; + stringnullwebIndex&null; @@ -32,7 +32,7 @@ - webindex + webIndex Relative path within the phar archive to run if accessed through a web browser @@ -58,6 +58,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + webIndex is nullable now. + + + + + + + &reftitle.seealso; @@ -68,7 +90,6 @@ - &Methods; + + + - + &InheritedMethods; diff --git a/reference/phar/PharFileInfo/chmod.xml b/reference/phar/PharFileInfo/chmod.xml index 19dcbaecf1..b8e579bfff 100644 --- a/reference/phar/PharFileInfo/chmod.xml +++ b/reference/phar/PharFileInfo/chmod.xml @@ -1,6 +1,6 @@ - + PharFileInfo::chmod Sets file-specific permission bits @@ -9,7 +9,7 @@ &reftitle.description; public voidPharFileInfo::chmod - intpermissions + intperms @@ -31,7 +31,7 @@ - permissions + perms permissions (see chmod) @@ -85,7 +85,6 @@ bool(true) - - + PharFileInfo::__construct Construct a Phar entry object &reftitle.description; - + public PharFileInfo::__construct - stringentry - + stringfilename + This should not be called directly. Instead, a PharFileInfo object @@ -24,7 +24,7 @@ - entry + filename The full url to retrieve a file. If you wish to retrieve the information @@ -92,7 +92,6 @@ line number 3: dude - - + PharFileInfo::getMetadata Returns file-specific meta-data saved with a file @@ -9,7 +9,7 @@ &reftitle.description; public mixedPharFileInfo::getMetadata - + arrayunserializeOptions[] @@ -30,6 +30,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + The parameter unserializeOptions has been added. + + + + + + + &reftitle.examples; @@ -83,7 +105,6 @@ array(2) { - - + PharFileInfo::isCompressed Returns whether the entry is compressed @@ -9,7 +9,7 @@ &reftitle.description; public boolPharFileInfo::isCompressed - intcompression_type9021976 + intnullcompression&null; @@ -23,7 +23,7 @@ - compression_type + compression One of Phar::GZ or Phar::BZ2, @@ -42,6 +42,28 @@ + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + compression is now nullable. + + + + + + + &reftitle.examples; @@ -95,7 +117,6 @@ bool(true) -