rfc:streamline-phar-api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
rfc:streamline-phar-api [2008/03/28 14:53] – save temporarily lstrojnyrfc:streamline-phar-api [2008/03/28 15:03] – Adding more explaination to the purpose of Phar::isWritable() lstrojny
Line 3: Line 3:
 This proposal aims to streamline the Phar API to make it more usable and intuitive.  This proposal aims to streamline the Phar API to make it more usable and intuitive. 
 ===== Concrete change proposals ===== ===== Concrete change proposals =====
 +
 +
 ==== Phar ==== ==== Phar ====
 === Modifying Phar archive content === === Modifying Phar archive content ===
Line 11: Line 13:
   * offsetUnset()   * offsetUnset()
 == Proposal == == Proposal ==
-In the current API, every path is represented by a single array index. This is counter intuitive, as a multi-dimensional structure (the archive) is represented as a single dimensional array accessible object. The idea is to change that object to be +In the current API, every path is represented by a single array index. This is counter intuitive, as a multi-dimensional structure (the archive) is represented as a single dimensional array accessible object. The idea is to change that object to represent every path element (e.g. "bar" in "foo/bar/baz") as a single index. This would be accomplished by letting the DirectoryIterator implement ArrayAccess.
 == Code == == Code ==
 <code php> <code php>
Line 18: Line 20:
 </code> </code>
  
 +=== Adding isWritable() method ===
 +== Proposal ==
 +Add an isWritable() method to determine whether an archive can be written or not. Not being able to write an archive either means it is disabled in the php.ini (see Phar::canWrite()) or that PHP can't write to the requested location of the phar archive.
 +== Code ==
 +<code php>
 +$phar = new Phar('test.phar');
 +if ($phar->isWritable()) {
 +    $phar['path']['to']['file'] = "test";
 +}
 +</code>
 +
 +=== Adding createDirectory() ===
 +== Proposal ==
 +Add the method Phar->createDirectory() to explicitly create a new directory. createDirectory() will return another Phar object and takes a dirname (string) as an argument.
 +== Code ==
 +<code php>
 +$phar = new Phar('test.phar');
 +$dir = $phar->createDirectory('foo');
 +$dir['file'] = 'content'; // Set the file 'foo/file' to 'content'
 +</code>
  
 ==== SplFileInfo ==== ==== SplFileInfo ====
rfc/streamline-phar-api.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools