Changeset 850d3cc

Timestamp:

12/18/11 14:33:41 (5 months ago)

Author:

mrook

Branches:

master

Children:

ddec066

Parents:

8c44f33

git-author:

Michiel Rook <mrook@…> (12/18/11 14:33:41)

git-committer:

Michiel Rook <mrook@…> (12/18/11 14:33:41)

Message:

Fixes #674 - discuss property scope in phingcall blocks

File:

• docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html (modified) (3 diffs)

docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html

@@ -1885 +1885 @@
         </h2>
         <p>
-                The PhingCallTask calls a target from the same Phing project. A <em>&lt;phingcall&gt;</em>
-                tag may contain <em>&lt;property&gt;</em> tags that define new
-                properties. In the following example, the properties <em>property1</em>
-                and <em>foo</em> are defined and only accessible inside the called
-                target.
-        </p>
-        <p>
-                However, this will only work if the properties are not yet set outside
+                The PhingCallTask calls a target within the same Phing project.
+        </p>
+        
+        <p>
+        A <em>&lt;phingcall&gt;</em> tag may contain <em>&lt;property&gt;</em>
+        tags that define new properties. These properties are only set if properties
+        of the same name have not been set outside
                 the
                 <code>&quot;phingcall&quot;</code>
                 tag.
         </p>
+        
+        <p>
+           <b>Important note about scope:</b> every <em>&lt;phingcall&gt;</em> tag
+           creates a new local scope. Thus, any properties or other variables set inside
+           that scope will cease to exist (or revert to their previous value) once
+           the <em>&lt;phingcall&gt;</em> tag completes. 
+        </p>
+        
         <h3>Example</h3>
         <pre>&lt;target name=&quot;foo&quot;&gt;
@@ -1903 +1910 @@
         &lt;property name=&quot;foo&quot; value=&quot;baz&quot; /&gt;
     &lt;/phingcall&gt;
-&lt;/target&gt;
-
-&lt;target name=&quot;bar&quot; depends=&quot;init&quot;&gt;
+&lt;/target&gt;</pre>
+
+    <p>
+        In the example above, the properties <em>property1</em>
+        and <em>foo</em> are defined and only accessible inside the called
+        target.
+    </p>
+
+<pre>&lt;target name=&quot;bar&quot; depends=&quot;init&quot;&gt;
     &lt;echo message=&quot;prop is ${property1} ${foo}&quot; /&gt;
 &lt;/target&gt;</pre>
@@ -2025 +2038 @@
                 build file.
         </p>
+        
+        <p>
+       <b>Important note about scope:</b> when the <em>&lt;property&gt;</em> tag
+       is called inside a <em>&lt;phingcall&gt;</em> tag, any properties are
+       set in a new local scope. Thus, any properties or other variables set inside
+       that scope will cease to exist (or revert to their previous value) once
+       the parent <em>&lt;phingcall&gt;</em> tag completes. 
+    </p>
+        
         <h3>Example</h3>
         <pre>&lt;property name=&quot;strings.test&quot; value=&quot;Harr harr, more power!&quot; /&gt;