/version/1.1.2/manual/offline/commands.make-vendor.html
HTML | 194 lines | 194 code | 0 blank | 0 comment | 0 complexity | 7f08ad7f630537c603bcb277c9a27fe9 MD5 | raw file
Possible License(s): IPL-1.0, LGPL-2.0, Apache-2.0, 0BSD
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>8.2. Make Vendor Source</title>
- <link rel="stylesheet" href="style.css" type="text/css" />
- <meta name="generator" content="DocBook XSL-NS Stylesheets V1.75.2" />
- <link rel="home" href="index.html" title="The Solar Framework for PHP" />
- <link rel="up" href="commands.html" title="Chapter 8. Command-Line Tools" />
- <link rel="prev" href="commands.intro.html" title="8.1. Introduction" />
- <link rel="next" href="commands.link-vendor.html" title="8.3. Link Vendor Source" />
- <link rel="part" href="pt01.html" title="Part I. Getting Started" />
- <link rel="chapter" href="blog-demo.html" title="Chapter 1. Quick-Start Blog Demo" />
- <link rel="chapter" href="dispatch-cycle.html" title="Chapter 2. Dynamic Dispatch Cycle" />
- <link rel="chapter" href="model.html" title="Chapter 3. Working With Models" />
- <link rel="chapter" href="related.html" title="Chapter 4. Working With Related Models" />
- <link rel="chapter" href="views.html" title="Chapter 5. Views and Layouts" />
- <link rel="chapter" href="form.html" title="Chapter 6. Models and Forms" />
- <link rel="chapter" href="user.html" title="Chapter 7. User Authentication, Roles, and Access Control" />
- <link rel="chapter" href="commands.html" title="Chapter 8. Command-Line Tools" />
- <link rel="chapter" href="mail.html" title="Chapter 9. Mail" />
- <link rel="part" href="pt02.html" title="Part II. Appendices" />
- <link rel="appendix" href="appendix-standards.html" title="Appendix A. Project Standards" />
- <link rel="appendix" href="appendix-naming.html" title="Appendix B. Naming Conventions" />
- <link rel="subsection" href="commands.make-vendor.html#commands.make-vendor.example" title="8.2.1. Example" />
- </head>
- <body>
- <div class="navheader">
- <table width="100%" summary="Navigation header">
- <tr>
- <th colspan="3" align="center">8.2. Make Vendor Source</th>
- </tr>
- <tr>
- <td width="20%" align="left"><a accesskey="p" href="commands.intro.html">Prev</a> </td>
- <th width="60%" align="center">Chapter 8. Command-Line Tools</th>
- <td width="20%" align="right"> <a accesskey="n" href="commands.link-vendor.html">Next</a></td>
- </tr>
- </table>
- </div>
- <div class="sect1" title="8.2. Make Vendor Source">
- <div class="titlepage">
- <div>
- <div>
- <h2 class="title" style="clear: both"><a id="commands.make-vendor"></a>8.2. Make Vendor Source</h2>
- </div>
- </div>
- </div>
- <div class="cmdsynopsis">
- <p><code class="command">./script/solar make-vendor</code> <em class="replaceable"><code>VendorName</code></em> </p>
- </div>
- <p>
- The <span class="command"><strong>make-vendor</strong></span> command creates all the basic
- source files for a new vendor space inside a Solar system. The
- idea is, when you start a new project, you will use a new vendor
- space for the controllers, models, views, and other components of
- the application. You can have as many vendors as you like, so long as
- their names are different.
- </p>
- <div class="sect2" title="8.2.1. Example">
- <div class="titlepage">
- <div>
- <div>
- <h3 class="title"><a id="commands.make-vendor.example"></a>8.2.1. Example</h3>
- </div>
- </div>
- </div>
- <p>
- To create a new vendor space inside a Solar system, issue the
- following command:
- </p>
- <pre class="screen">$ <strong class="userinput"><code>./script/solar make-vendor <em class="replaceable"><code>VendorName</code></em></code></strong>
- Making vendor source directories.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/config.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/docs.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/script.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/tests.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/tests/Mock.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/tests/Mock/<em class="replaceable"><code>VendorName</code></em>.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/tests/Test.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/tests/Test/<em class="replaceable"><code>VendorName</code></em>.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help/Info.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help/Locale.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/Locale.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/Public.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Command/Info.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Command/Locale.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Page/Layout.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Page/Locale.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Page/Public.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Page/View.
- Creating <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Model.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help/Info/options.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/Locale/en_US.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/_item.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/_list.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/add.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/browse.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/delete.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/edit.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/read.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Bread/View/search.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Command.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Controller/Page.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Filter.php ... done.
- Making directory <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql/Model.php ... done.
- Making directory <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql/Model ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql/Model/Collection.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql/Model/Metadata.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Sql/Model/Record.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/config/default.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/config/run-tests.php ... done.
- Writing <em class="replaceable"><code>SYSTEM</code></em>/source/<em class="replaceable"><code>vendor-name</code></em>/<em class="replaceable"><code>VendorName</code></em>/Cli/Help/Info/help.txt ... done.
- Making links for vendor '<em class="replaceable"><code>VendorName</code></em>' ...
- Making link 'include/<em class="replaceable"><code>VendorName</code></em>' ... done.
- Making link 'include/Test/<em class="replaceable"><code>VendorName</code></em>' ... done.
- Making link 'include/Mock/<em class="replaceable"><code>VendorName</code></em>' ... done.
- Making link 'script/<em class="replaceable"><code>vendor-name</code></em>' ... done.
- ... done.
- Making public symlinks for '<em class="replaceable"><code>VendorName</code></em>' ...
- Making public directory docroot/public/<em class="replaceable"><code>VendorName</code></em>/Controller ... done.
- Making public symlink for <em class="replaceable"><code>VendorName</code></em>_Controller_Bread ... done.
- Making public symlink for <em class="replaceable"><code>VendorName</code></em>_Controller_Page ... done.
- ... done.
- Remember to add '<em class="replaceable"><code>VendorName</code></em>_App' to the ['Solar_Controller_Front']['classes'] element in your config file so that it finds your apps.
- Remember to add '<em class="replaceable"><code>VendorName</code></em>_Model' to the ['Solar_Sql_Model_Catalog']['classes'] element in your config file so that it finds your models.
- $</pre>
- <p>
- What is going on here?
- </p>
- <div class="itemizedlist">
- <ul class="itemizedlist" type="disc">
- <li class="listitem">
- <p>
- The command creates a new source directory for
- <em class="replaceable"><code>vendor-name</code></em> and adds some standard
- directories therein: <code class="filename">config</code> for default
- configuration files, <code class="filename">docs</code> for
- documentation files, <code class="filename">script</code> for the
- <em class="replaceable"><code>vendor-name</code></em> command-line interface,
- <code class="filename">tests</code> for integration tests, and of
- course the
- <code class="filename"><em class="replaceable"><code>VendorName</code></em></code>
- directory for PHP classes.
- </p>
- </li>
- <li class="listitem">
- <p>
- The command creates a series of baseline classes and
- directories for <em class="replaceable"><code>VendorName</code></em> PHP code:
- a minimal page controller, a boilerplace browse/read/edit/add/delete ("BREAD")
- controller, a base class for <em class="replaceable"><code>VendorName</code></em>-specific
- models, directories for view helpers and concrete model classes,
- and so on.
- </p>
- </li>
- <li class="listitem">
- <p>
- Finally, the command creates symbolic links from the source
- directory to other locations in the Solar system, so that
- when source files change, you don't need to copy them out
- to the rest of the system.
- </p>
- </li>
- </ul>
- </div>
- </div>
- </div>
- <div class="navfooter">
- <table width="100%" summary="Navigation footer">
- <tr>
- <td width="40%" align="left"><a accesskey="p" href="commands.intro.html">Prev</a> </td>
- <td width="20%" align="center">
- <a accesskey="u" href="commands.html">Up</a>
- </td>
- <td width="40%" align="right"> <a accesskey="n" href="commands.link-vendor.html">Next</a></td>
- </tr>
- <tr>
- <td width="40%" align="left" valign="top">8.1. Introduction </td>
- <td width="20%" align="center">
- <a accesskey="h" href="index.html">Home</a>
- </td>
- <td width="40%" align="right" valign="top"> 8.3. Link Vendor Source</td>
- </tr>
- </table>
- </div>
- <div xmlns="" class="revinfo"></div>
- </body>
- </html>