phar.setstub(3) [php man page]

PHAR.SETSTUB(3) 							 1							   PHAR.SETSTUB(3)

Phar::setStub - Used to set the PHP loader or bootstrap stub of a Phar archive

SYNOPSIS

       public bool Phar::setStub (string  $stub, [int  $len = -1])

DESCRIPTION

       Note

	      This  method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException
	      will be thrown.

	This method is used to add a PHP bootstrap loader stub to a new Phar archive, or to replace the loader stub in an existing Phar archive.

	The loader stub for a Phar archive is used whenever an archive is included directly as in this example:

       <?php
       include 'myphar.phar';
       ?>

	The loader is not accessed when including a file through the phar stream wrapper like so:

       <?php
       include 'phar://myphar.phar/somefile.php';
       ?>

PARAMETERS

	      o $stub
		- A string or an open stream handle to use as the executable stub for this phar archive.

	      o $len
		-

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

ERRORS
/EXCEPTIONS
       UnexpectedValueException is thrown if phar.readonly is enabled in php.ini. PharException is thrown if any problems are encountered flushing
       changes to disk.

EXAMPLES

       Example #1

	      A Phar.setStub(3) example

	      <?php
	      try {
		  $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
		  $p['a.php'] = '<?php var_dump("Hello");';
		  $p->setStub('<?php var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>');
		  include 'phar://brandnewphar.phar/a.php';
		  var_dump($p->getStub());
		  $p['b.php'] = '<?php var_dump("World");';
		  $p->setStub('<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>');
		  include 'phar://brandnewphar.phar/b.php';
		  var_dump($p->getStub());
	      } catch (Exception $e) {
		  echo 'Write operations failed on brandnewphar.phar: ', $e;
	      }
	      ?>

	      The above example will output:

	      string(5) "Hello"
	      string(82) "<?php var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>"
	      string(5) "World"
	      string(83) "<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>"

CHANGELOG

       +--------+------------------------+
       |Version |			 |
       |	|			 |
       |	|      Description	 |
       |	|			 |
       +--------+------------------------+
       | 5.4.0	|			 |
       |	|			 |
       |	|  Added $len parameter. |
       |	|			 |
       +--------+------------------------+
SEE ALSO

       Phar.getStub(3), Phar.createDefaultStub(3).

PHP Documentation Group 													   PHAR.SETSTUB(3)

Check Out this Related Man Page

PHARDATA.EXTRACTTO(3)							 1						     PHARDATA.EXTRACTTO(3)

PharData::extractTo - Extract the contents of a tar/zip archive to a directory

SYNOPSIS

       bool PharData::extractTo (string  $pathto, [string|array  $files], [bool  $overwrite = false])

DESCRIPTION

	Extract  all  files  within  a tar/zip archive to disk. Extracted files and directories preserve permissions as stored in the archive. The
       optional parameters allow optional control over which files are extracted, and whether existing files on disk can be overwritten. The  sec-
       ond  parameter files can be either the name of a file or directory to extract, or an array of names of files and directories to extract. By
       default, this method will not overwrite existing files, the third parameter can be set to true to enable overwriting of files. This  method
       is similar to ZipArchive.extractTo(3).

PARAMETERS

	      o $pathto
		- Path to extract the given files to

	      o $files
		- The name of a file or directory to extract, or an array of files/directories to extract

	      o $overwrite
		- Set to TRUE to enable overwriting existing files

RETURN VALUES

	returns TRUE on success, but it is better to check for thrown exception, and assume success if none is thrown.

ERRORS
/EXCEPTIONS
	Throws PharException if errors occur while flushing changes to disk.

EXAMPLES

       Example #1

	      A PharData.extractTo(3) example

	      <?php
	      try {
		  $phar = new PharData('myphar.tar');
		  $phar->extractTo('/full/path'); // extract all files
		  $phar->extractTo('/another/path', 'file.txt'); // extract only file.txt
		  $phar->extractTo('/this/path',
		      array('file1.txt', 'file2.txt')); // extract 2 files only
		  $phar->extractTo('/third/path', null, true); // extract all files, and overwrite
	      } catch (Exception $e) {
		  // handle errors
	      }
	      ?>

SEE ALSO

       Phar.extractTo(3).

PHP Documentation Group 												     PHARDATA.EXTRACTTO(3)

Linux and UNIX Man Pages

phar.setstub(3) [php man page]

Check Out this Related Man Page