Merge pull request #78 from gios-asu/develop

Prod: Better support for isolating multiple view path
asu-ke-web-services · Nov 10, 2016 · c6f3b96 · c6f3b96
2 parents 25ad186 + 8daae96
commit c6f3b96
Show file tree

Hide file tree

Showing 42 changed files with 559 additions and 791 deletions.
diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory.xhtml
@@ -85,8 +85,8 @@
                     </li><li>public $this <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/add_data.xhtml">add_data</a>()
                     </li><li>public $this <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/add_head.xhtml">add_head</a>()
                     </li><li>public void <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/build.xhtml">build</a>()
-                    </li><li>private void <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_view_root.xhtml">get_view_root</a>()
                     </li><li>private void <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_template_name.xhtml">get_template_name</a>()
+                    </li><li>private void <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_path_to_views.xhtml">get_path_to_views</a>()
                     </li><li>private void <a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_file_extension.xhtml">get_file_extension</a>()
                     </li></ul><ul class="none"><li>// Inherited methods from <span title="Nectary\Factory">Factory</span></li><li>public abstract void <a title="Nectary\Factory" href="../classes/Nectary_Factory/build.xhtml">build</a>()
                         </li></ul>
@@ -125,10 +125,10 @@
           <ul>
             <li id="get_file_extension"><a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_file_extension.xhtml">get_file_extension()</a>
                 — Find the first file extention that matches the for this view template</li>
+            <li id="get_path_to_views"><a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_path_to_views.xhtml">get_path_to_views()</a>
+                — Get the path to the views, either the configuration path or the overridden path</li>
             <li id="get_template_name"><a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_template_name.xhtml">get_template_name()</a>
-                — Given the 'object'-like path, determine the template name for the view</li>
-            <li id="get_view_root"><a title="Nectary\Factories\View_Factory" href="../classes/Nectary_Factories_View_Factory/get_view_root.xhtml">get_view_root()</a>
-                — Given the 'object'-like path, determine the root directory for the view</li>
+                — Given the 'object'-like path, determine the template name for the view.</li>
           </ul>
           <h4>public</h4>
           <ul>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/__construct.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/__construct.xhtml
@@ -62,7 +62,7 @@
             <a href="#parameter">Parameter</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line38">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line40">Source</a>
           </li>
         </ul>
       </nav>
@@ -74,7 +74,9 @@
         <h2 id="signature">Signature</h2>
         <div class="styled synopsis">
           <code>public function __construct(<a title="Nectary\Factories\String" href="../../classes/Nectary_Factories_String.xhtml">String</a>
-        $view_name )
+        $view_name,
+            [<a title="Nectary\Factories\String" href="../../classes/Nectary_Factories_String.xhtml">String</a>
+        $path_to_views = null] )
             </code>
         </div>
         <h2 id="parameterlist">Parameters</h2>
@@ -83,6 +85,10 @@
                 —
                 object</dt>
           <dd>The 'path'-like string to the view.<br/><br/><br/>      </dd>
+          <dt><code>$path_to_views</code>
+                —
+                object</dt>
+          <dd>An actual directory path that will override<br/>the global nectary configuration.</dd>
         </dl>
       </section>
     </div>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/add_data.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/add_data.xhtml
@@ -65,7 +65,7 @@
             <a href="#return">Return</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line79">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line82">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/add_head.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/add_head.xhtml
@@ -65,7 +65,7 @@
             <a href="#return">Return</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line110">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line113">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/build.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/build.xhtml
@@ -62,7 +62,7 @@
             <a href="#overrides">Overrides</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line127">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line130">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/get_file_extension.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/get_file_extension.xhtml
@@ -62,7 +62,7 @@
             <a href="#parameter">Parameter</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line202">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line189">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/...actories_View_Factory/get_view_root.xhtml → ...ries_View_Factory/get_path_to_views.xhtml b/...actories_View_Factory/get_view_root.xhtml → ...ries_View_Factory/get_path_to_views.xhtml
@@ -47,7 +47,7 @@
           <li class="separator">
             <a title="Nectary\Factories\View_Factory" href="../../classes/Nectary_Factories_View_Factory.xhtml">View_Factory</a>
           </li>
-          <li class="separator">get_view_root</li>
+          <li class="separator">get_path_to_views</li>
         </ul>
       </div>
       <nav class="box">
@@ -59,18 +59,18 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line164">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line178">Source</a>
           </li>
         </ul>
       </nav>
       <section>
-        <h1><small>Nectary\Factories\View_Factory::</small>get_view_root</h1>
-        <h4>Given the 'object'-like path, determine the root directory for the view</h4>
+        <h1><small>Nectary\Factories\View_Factory::</small>get_path_to_views</h1>
+        <h4>Get the path to the views, either the configuration path or the overridden path</h4>
         <p/>
         <ul/>
         <h2 id="signature">Signature</h2>
         <div class="styled synopsis">
-          <code>private function get_view_root()
+          <code>private function get_path_to_views()
             </code>
         </div>
       </section>

diff --git a/documentation/api/html/classes/Nectary_Factories_View_Factory/get_template_name.xhtml b/documentation/api/html/classes/Nectary_Factories_View_Factory/get_template_name.xhtml
@@ -59,14 +59,15 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/factories/implementations/view-factory.php.xhtml#line184">Source</a>
+            <a href="../../source/factories/implementations/view-factory.php.xhtml#line171">Source</a>
           </li>
         </ul>
       </nav>
       <section>
         <h1><small>Nectary\Factories\View_Factory::</small>get_template_name</h1>
-        <h4>Given the 'object'-like path, determine the template name for the view</h4>
-        <p/>
+        <h4>Given the 'object'-like path, determine the template name for the view.</h4>
+        <p>eg: $this-&gt;view_name = 'blah.foo'
+  get_template_name() returns 'blah/foo'</p>
         <ul/>
         <h2 id="signature">Signature</h2>
         <div class="styled synopsis">

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/__construct.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/__construct.xhtml
@@ -84,7 +84,7 @@
           <dt><code>$view_root</code>
                 —
                 string</dt>
-          <dd>Use false if you are not using views<br/><br/><br/>      </dd>
+          <dd>Use false if you are not rendering views from files<br/><br/><br/>      </dd>
           <dt><code>$path_to_views</code>
                 —
                 </dt>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_conditional_operators.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_conditional_operators.xhtml
@@ -59,7 +59,7 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line139">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line129">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_config.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_config.xhtml
@@ -59,7 +59,7 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line81">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line71">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_engine_helpers.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_engine_helpers.xhtml
@@ -59,7 +59,7 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line74">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line64">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/...ation/api/html/classes/Nectary_Views_Handlebars_View/add_html_special_chars_handler.xhtml b/...ation/api/html/classes/Nectary_Views_Handlebars_View/add_html_special_chars_handler.xhtml
@@ -59,7 +59,7 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line123">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line113">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_strip_tags.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/add_strip_tags.xhtml
@@ -59,7 +59,7 @@
             <a href="#synopsis">Synopsis</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line108">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line98">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/get_real_value.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/get_real_value.xhtml
@@ -62,7 +62,7 @@
             <a href="#parameter">Parameter</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line197">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line187">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/is_conditional_true.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/is_conditional_true.xhtml
@@ -62,7 +62,7 @@
             <a href="#parameter">Parameter</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line172">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line162">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Handlebars_View/render.xhtml b/documentation/api/html/classes/Nectary_Views_Handlebars_View/render.xhtml
@@ -62,7 +62,7 @@
             <a href="#parameter">Parameter</a>
           </li>
           <li>
-            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line61">Source</a>
+            <a href="../../source/view/extensions/handlebars-view.php.xhtml#line51">Source</a>
           </li>
         </ul>
       </nav>

diff --git a/documentation/api/html/classes/Nectary_Views_Simple_Handlebars_View/__construct.xhtml b/documentation/api/html/classes/Nectary_Views_Simple_Handlebars_View/__construct.xhtml
@@ -77,7 +77,9 @@
 
         $template_name,
 
-        $callback )
+        $callback,
+            [
+        $path_to_views = null] )
             </code>
         </div>
         <h2 id="parameterlist">Parameters</h2>
@@ -94,6 +96,10 @@
                 —
                 </dt>
           <dd/>
+          <dt><code>$path_to_views</code>
+                —
+                </dt>
+          <dd/>
         </dl>
       </section>
     </div>

diff --git a/documentation/api/html/index.xhtml b/documentation/api/html/index.xhtml
@@ -40,7 +40,7 @@
       </div>
       <div id="buildinfo">
         <h3>Build</h3>
-        <p>Wed, 09 Nov 2016 12:43:02 -0700</p>
+        <p>Thu, 10 Nov 2016 09:51:20 -0700</p>
         <h3>VCS Info</h3>
         <p>
                     tag: <br/>

diff --git a/documentation/api/html/source/configuration/index.xhtml b/documentation/api/html/source/configuration/index.xhtml
@@ -67,7 +67,7 @@
           </td>
           <td>2.5 KB
                 </td>
-          <td>2016-11-09T10:36:51-07:00</td>
+          <td>2016-11-09T16:40:52-07:00</td>
         </tr>
         <tr>
           <td colspan="3">

diff --git a/documentation/api/html/source/daos/index.xhtml b/documentation/api/html/source/daos/index.xhtml
@@ -75,7 +75,7 @@
           </td>
           <td>5.3 KB
                 </td>
-          <td>2016-11-09T10:18:39-07:00</td>
+          <td>2016-11-09T16:40:52-07:00</td>
         </tr>
         <tr>
           <td colspan="3">

diff --git a/documentation/api/html/source/factories/implementations/index.xhtml b/documentation/api/html/source/factories/implementations/index.xhtml
@@ -81,7 +81,7 @@
           </td>
           <td>1.9 KB
                 </td>
-          <td>2016-11-09T10:36:51-07:00</td>
+          <td>2016-11-09T16:40:52-07:00</td>
         </tr>
         <tr>
           <td>
@@ -103,9 +103,9 @@
           <td>
             <a href="view-factory.php.xhtml">view-factory.php</a>
           </td>
-          <td>5.2 KB
+          <td>5.0 KB
                 </td>
-          <td>2016-11-09T10:36:51-07:00</td>
+          <td>2016-11-10T09:50:22-07:00</td>
         </tr>
         <tr>
           <td colspan="3">

diff --git a/documentation/api/html/source/factories/implementations/view-factory.php.xhtml b/documentation/api/html/source/factories/implementations/view-factory.php.xhtml
diff --git a/documentation/api/html/source/helpers/index.xhtml b/documentation/api/html/source/helpers/index.xhtml
@@ -67,7 +67,7 @@
           </td>
           <td>783 Bytes
                 </td>
-          <td>2016-09-27T15:06:27-07:00</td>
+          <td>2016-11-09T16:40:52-07:00</td>
         </tr>
         <tr>
           <td colspan="3">

diff --git a/documentation/api/html/source/utilities/index.xhtml b/documentation/api/html/source/utilities/index.xhtml
@@ -67,7 +67,7 @@
           </td>
           <td>709 Bytes
                 </td>
-          <td>2016-09-27T15:06:27-07:00</td>
+          <td>2016-11-09T16:40:52-07:00</td>
         </tr>
         <tr>
           <td>

diff --git a/documentation/api/html/source/view/extensions/handlebars-view.php.xhtml b/documentation/api/html/source/view/extensions/handlebars-view.php.xhtml
diff --git a/documentation/api/html/source/view/extensions/index.xhtml b/documentation/api/html/source/view/extensions/index.xhtml
@@ -71,9 +71,9 @@
           <td>
             <a href="handlebars-view.php.xhtml">handlebars-view.php</a>
           </td>
-          <td>6.0 KB
+          <td>5.8 KB
                 </td>
-          <td>2016-11-09T10:36:51-07:00</td>
+          <td>2016-11-10T09:50:22-07:00</td>
         </tr>
         <tr>
           <td colspan="3">

diff --git a/documentation/api/html/source/view/implementations/index.xhtml b/documentation/api/html/source/view/implementations/index.xhtml
@@ -71,9 +71,9 @@
           <td>
             <a href="simple-handlebars-view.php.xhtml">simple-handlebars-view.php</a>
           </td>
-          <td>538 Bytes
+          <td>577 Bytes
                 </td>
-          <td>2015-09-18T12:37:13-07:00</td>
+          <td>2016-11-10T09:50:22-07:00</td>
         </tr>
         <tr>
           <td colspan="3">