| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html lang="en"> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2008. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <title> |
| PHAR File Exporter |
| </title> |
| <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> |
| </head> |
| <body> |
| <h1> |
| PHAR File Exporter |
| </h1> |
| <p> |
| The |
| <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.file.export(exportWizardId=org.eclipse.jdt.internal.ui.jarpackager.JarPackageWizard)")'> |
| <img src="PLUGINS_ROOT/org.eclipse.help/command_link.png" alt="Opens the PHAR export wizard"> |
| <b>Phar Export</b></a> wizard |
| allows you to create a PHAR file. |
| </p> |
| <h2> |
| PHAR package specification |
| </h2> |
| <p> |
| PHAR Specification Options: |
| </p> |
| <table border="1" cellspacing="0" cellpadding="5" summary="PHAR specification options"> |
| <tbody> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Select the resources to export |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| In the list, check or clear the boxes to specify exactly the files that you want to export to the PHAR file. This list is initialized by the workbench selection. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Export generated class files and resources |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| If enabled, then generated class files and resources are included in the PHAR. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Export all output folders for checked projects |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| If enabled, then all output folders are included in the PHAR. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Export PHP source files and resources |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| If enabled, then PHP source files and resources are included in the PHAR. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Export refactorings for checked projects |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| If enabled, then refactoring scripts for the selected projects are included in the PHAR. This allows |
| clients to migrate to the new PHAR by executing all the stored refactorings in the PHAR. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Select the export destination |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| Enter an external file system path and name for a PHAR file (either new or existing). Either type a valid file path in the field or click Browse to select a file via |
| a dialog. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Options |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| You can select any of the following options: |
| </p> |
| <ul> |
| <li> |
| <strong>Compress the contents of the PHAR file </strong>: to create a compressed PHAR file |
| </li> |
| <li> |
| <strong>Add directory entries</strong>: adds an entry for each directory to the PHAR file, even if the directory does only contain subdirectories. |
| </li> |
| <li> |
| <strong>Overwrite existing files without warning</strong> : if an existing file might be overwritten, you are prompted for confirmation. This option is applied to |
| the PHAR file, the PHAR description, and the manifest file. |
| </li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h2> |
| PHAR packaging options |
| </h2> |
| <p> |
| PHAR Options: |
| </p> |
| <table border="1" cellspacing="0" cellpadding="5" summary="PHAR options"> |
| <tbody> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Select options for handling problems |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| Choose whether to export classes with certain problems: |
| </p> |
| <ul> |
| <li> |
| Export class files with compile errors |
| </li> |
| <li> |
| Export class files with compile warnings |
| </li> |
| </ul> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| Create source folder structure |
| </td> |
| <td> |
| Selected this option if you want the source folder structure to be rebuilt in the PHAR. This option is only enabled when source files but no class files are |
| exported. |
| </td> |
| </tr> |
| <tr> |
| <td> |
| Build projects if not build automatically |
| </td> |
| <td> |
| Select this option to force a rebuild before exporting. It is recommended to build be before exporting so the exported class files are up to date. |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Save the description of this PHAR in the workspace |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| If you select this option, you can create a file in the workbench describing the PHAR file you are creating. Either type and/or browse to select a path and name for |
| this new file. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h2> |
| PHAR manifest specification |
| </h2> |
| <p> |
| PHAR Manifest Specification Options (Available when class file are exported): |
| </p> |
| <table border="1" cellspacing="0" cellpadding="5" summary="PHAR manifest specification"> |
| <tbody> |
| <tr> |
| <th> |
| <p> |
| Option |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Specify the manifest |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| Choose the source of the manifest file for this PHAR file: |
| </p> |
| <ul> |
| <li> |
| <b>Generate the manifest file</b> (you can also choose either to save or reuse and save the new manifest file) |
| </li> |
| <li> |
| <b>Use existing manifest from workspace</b> |
| </li> |
| </ul> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Seal contents |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| Choose which packages in the PHAR file must be sealed: |
| </p> |
| <ul> |
| <li> |
| <b>Seal the PHAR</b> to seal the entire PHAR file; click <strong>Details</strong> to exclude selectively |
| </li> |
| <li> |
| <b>Seal some packages</b> click <strong>Details</strong> to choose selectively |
| </li> |
| </ul> |
| <em>Note: This option is only available if the manifest is generated.</em> |
| </td> |
| </tr> |
| <tr> |
| <td align="left" valign="top"> |
| <p> |
| Select the class of the application entry point |
| </p> |
| </td> |
| <td align="left" valign="top"> |
| <p> |
| Type or click <strong>Browse</strong> to select the main class for the PHAR file, if desired. |
| </p> |
| <em>Note: This option is only available if the manifest is generated.</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <p> |
| <img src="ngrelt.png" alt="Related tasks" border="0" ></p> |
| <p> |
| <a href="tasks-32.htm">Creating PHAR files</a> |
| </p> |
| <p> |
| <img src="ngrelr.png" alt="Related reference"></p> |
| |
| </body> |
| </html> |
| |
