Changeset 119

Timestamp:

09/14/06 20:02:22 (2 years ago)

Author:

mrook

Message:

Check-in of improvements to various tasks (contributed by Andrew Eddie)

Files:

• trunk/classes/phing/tasks/defaults.properties (modified) (1 diff)
• trunk/classes/phing/tasks/ext/ioncube/IoncubeEncoderTask.php (modified) (11 diffs)
• trunk/classes/phing/tasks/ext/svn/SvnBaseTask.php (modified) (4 diffs)
• trunk/classes/phing/tasks/ext/svn/SvnCheckoutTask.php (added)
• trunk/classes/phing/tasks/ext/svn/SvnExportTask.php (modified) (2 diffs)
• trunk/classes/phing/tasks/ext/svn/SvnUpdateTask.php (added)
• trunk/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html (modified) (8 diffs)

trunk/classes/phing/tasks/defaults.properties

@@ -59 +59 @@
-phpdoc=phing.tasks.ext.phpdoc.PHPDocumentorTask
-svnlastrevision=phing.tasks.ext.svn.SvnLastRevisionTask
+svncheckout=phing.tasks.ext.svn.SvnCheckoutTask.php
-svnexport=phing.tasks.ext.svn.SvnExportTask
+svnupdate=phing.tasks.ext.svn.SvnUpdateTask
-phpunit2=phing.tasks.ext.phpunit2.PHPUnit2Task
-phpunit2report=phing.tasks.ext.phpunit2.PHPUnit2ReportTask

trunk/classes/phing/tasks/ext/ioncube/IoncubeEncoderTask.php

@@ -27 +27 @@
- *
- * @author Michiel Rook <michiel.rook@gmail.com>
+ * @author Andrew Eddie <andrew.eddie@jamboworks.com> 
- * @version $Id$
- * @package phing.tasks.ext.ioncube
@@ -33 +34 @@
-class IoncubeEncoderTask extends Task
-{
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-        private $comments = array();
+        
+        private $encoderName = 'ioncube_encoder';
+        
+        private $fromDir = '';
+
+        private $ioncubePath = '/usr/local/ioncube';
+
+        private $phpVersion = '5';
+
+        private $targetOption = '';
+
+        private $toDir = '';
+
+        /**
+         * Adds a comment to be used in encoded files
+         */
+        function addComment(IoncubeComment $comment)
+        {
+                $this->comments[] = $comment;
+        }
+
+        /**
+         * Sets the allowed server
+         */
+        function setAllowedServer($value)
+        {
+                $this->ionOptionsXS['allowed-server'] = $value;
+        }
+
+        /**
+         * Returns the allowed server setting
+         */
+        function getAllowedServer()
+        {
+                return $this->ionOptionsXS['allowed-server'];
+        }
+
+        /**
+         * Sets the binary option
+         */
+        function setBinary($value)
+        {
+                $this->ionSwitches['binary'] = $value;
+        }
+
+        /**
+         * Returns the binary option
+         */
+        function getBinary()
+        {
+                return $this->ionSwitches['binary'];
+        }
+
+        /**
+         * Sets files or folders to copy (separated by space)
+         */
+        function setCopy($value)
+        {
+                $this->ionOptionsXS['copy'] = $value;
+        }
+
+        /**
+         * Returns the copy setting
+         */
+        function getCopy()
+        {
+                return $this->ionOptionsXS['copy'];
+        }
+
+        /**
+         * Sets additional file patterns, files or directories to encode,
+         * or to reverse the effect of copy (separated by space)
+         */
+        function setEncode($value)
+        {
+                $this->ionOptionsXS['encode'] = $value;
+        }
+        
+        /**
+         * Returns the encode setting
+         */
+        function getEncode()
+        {
+                return $this->enionOptionsXS['encode'];
+        }
+
+        /**
+         * Sets regexps of additional files to encrypt (separated by space)
+         */
+        function setEncrypt($value)
+        {
+                $this->ionOptionsXS['encrypt'] = $value;
+        }
+        
+        /**
+         * Returns regexps of additional files to encrypt (separated by space)
+         */
+        function getEncrypt()
+        {
+                return $this->ionOptionsXS['encrypt'];
+        }
+
+        /**
+         * Sets a period after which the files expire
+         */
+        function setExpirein($value)
+        {
+                $this->ionOptions['expire-in'] = $value;
+        }
+        
+        /**
+         * Returns the expireIn setting
+         */
+        function getExpirein()
+        {
+                return $this->ionOptions['expire-in'];
+        }
+
+        /**
+         * Sets a YYYY-MM-DD date to expire the files 
+         */
+        function setExpireon($value)
+        {
+                $this->ionOptions['expire-on'] = $value;
+        }
+        
+        /**
+         * Returns the expireOn setting
+         */
+        function getExpireon()
+        {
+                return $this->ionOptions['expire-on'];
+        }
+
+        /**
+         * Sets the source directory
+         */
+        function setFromDir($value)
+        {
+                $this->fromDir = $value;
+        }
+
+        /**
+         * Returns the source directory
+         */
+        function getFromDir()
+        {
+                return $this->fromDir;
+        }
+
+        /**
+         * Set files and directories to ignore entirely and exclude from the target directory
+         * (separated by space).
+         */
+        function setIgnore($value)
+        {
+                $this->ionOptionsXS['ignore'] = $value;
+        }
+
+        /**
+         * Returns the ignore setting
+         */
+        function getIgnore()
+        {
+                return $this->ionOptionsXS['ignore'];
+        }
-
-        /**
-         * Sets the path to the ionCube encoder
-         */
-ioncubePath
-
-ioncubePath
+value
+
+value
-        }
-
@@ -69 +225 @@
-
-        /**
+         * Set files and directories not to be ignored (separated by space).
+         */
+        function setKeep($value)
+        {
+                $this->ionOptionsXS['keep'] = $value;
+        }
+
+        /**
+         * Returns the ignore setting
+         */
+        function getKeep()
+        {
+                return $this->ionOptionsXS['keep'];
+        }
+
+        /**
+         * Sets the path to the license file to use
+         */
+        function setLicensePath($value)
+        {
+                $this->ionOptions['with-license'] = $value;
+        }
+
+        /**
+         * Returns the path to the license file to use
+         */
+        function getLicensePath()
+        {
+                return $this->ionOptions['with-license'];
+        }
+
+        /**
+         * Sets the no-doc-comments option
+         */
+        function setNoDocComments($value)
+        {
+                $this->ionSwitches['no-doc-comment'] = $value;
+        }
+        
+        /**
+         * Returns the no-doc-comments option
+         */
+        function getNoDocComments()
+        {
+                return $this->ionSwitches['no-doc-comment'];
+        }
+        
+        /**
+         * Sets the obfuscate option
+         */
+        function setObfuscate($value)
+        {
+                $this->ionOptionsXS['obfuscate'] = $value;
+        }
+        
+        /**
+         * Returns the optimize option
+         */
+        function getObfuscate()
+        {
+                return $this->ionOptionsXS['obfuscate'];
+        }
+
+        /**
+         * Sets the obfuscation key (required if using the obfuscate option)
+         */
+        function setObfuscationKey($value)
+        {
+                $this->ionOptions['obfuscation-key'] = $value;
+        }
+        
+        /**
+         * Returns the optimize option
+         */
+        function getObfuscationKey()
+        {
+                return $this->ionOptions['obfuscation-key'];
+        }
+
+        /**
+         * Sets the optimize option
+         */
+        function setOptimize($value)
+        {
+                $this->ionOptions['optimize'] = $value;
+        }
+        
+        /**
+         * Returns the optimize option
+         */
+        function getOptimize()
+        {
+                return $this->ionOptions['optimize'];
+        }
+
+        /**
+         * Sets the passphrase to use when encoding files
+         */
+        function setPassPhrase($value)
+        {
+                $this->ionOptions['passphrase'] = $value;
+        }
+
+        /**
+         * Returns the passphrase to use when encoding files
+         */
+        function getPassPhrase()
+        {
+                return $this->ionOptions['passphrase'];
+        }
+
+        /**
-         * Sets the version of PHP to use (defaults to 5)
-         */
-phpVersion
-
-phpVersion
+value
+
+value
-        }
-
@@ -85 +353 @@
-        
-        /**
-         * Sets the source directory
-         */
-        function setFromDir($fromDir)
-        {
-                $this->fromDir = $fromDir;
-        }
-
-        /**
-         * Returns the source directory
-         */
-        function getFromDir($fromDir)
-        {
-                return $this->fromDir;
-        }
-        
-        /**
-         * Sets the target directory
-         */
-toDir
-
-toDir
+value
+
+value
-        }
-
@@ -111 +363 @@
-         * Returns the target directory
-         */
-$toDir
+
-        {
-                return $this->toDir;
@@ -117 +369 @@
-
-        /**
-         * Sets regexps of additional files to encrypt (separated by space)
-         */
-        function setEncrypt($encrypt)
-        {
-                $this->encrypt = $encrypt;
-        }
-        
-        /**
-         * Returns regexps of additional files to encrypt (separated by space)
-         */
-        function getEncrypt()
-        {
-                return $this->encrypt;
-        }
-        
-        /**
-         * Sets the binary option
-         */
-        function setBinary($binary)
-        {
-                $this->binary = $binary;
-        }
-        
-        /**
-         * Returns the binary option
-         */
-        function getBinary()
-        {
-                return $this->binary;
-        }
-
-        /**
-         * Sets the optimize option
-         */
-        function setOptimize($optimize)
-        {
-                $this->optimize = $optimize;
-        }
-        
-        /**
-         * Returns the optimize option
-         */
-        function getOptimize()
-        {
-                return $this->optimize;
-        }
-
-        /**
-         * Sets the without-runtime-loader-support option
-         */
-withoutRuntimeLoaderSupport
-
-withoutRuntimeLoaderSupport = $withoutRuntimeLoaderSupport
+value
+
+ionSwitches['without-runtime-loader-support'] = $value
-        }
-        
@@ -177 +381 @@
-        function getWithoutRuntimeLoaderSupport()
-        {
-withoutRuntimeLoaderSupport
+ionSwitches['without-runtime-loader-support']
-        }
-        
@@ -196 +400 @@
-        }
-        
-        /**
-         * Sets the path to the license file to use
-         */
-        function setLicensePath($licensePath)
-        {
-                $this->licensePath = $licensePath;
-        }
-
-        /**
-         * Returns the path to the license file to use
-         */
-        function getLicensePath()
-        {
-                return $this->licensePath;
-        }
-
-        /**
-         * Sets the passphrase to use when encoding files
-         */
-        function setPassPhrase($passPhrase)
-        {
-                $this->passPhrase = $passPhrase;
-        }
-
-        /**
-         * Returns the passphrase to use when encoding files
-         */
-        function getPassPhrase()
-        {
-                return $this->passPhrase;
-        }
-
-        /**
-         * Adds a comment to be used in encoded files
-         */
-        function addComment(IoncubeComment $comment)
-        {
-                $this->comments[] = $comment;
-        }
-
-        /**
-         * The main entry point
@@ -249 +413 @@
-                $this->log("Running ionCube Encoder...");
-                
-" "
+' '
-                
-        if ($return != 0)
@@ -262 +426 @@
-        private function constructArguments()
-        {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                }
-                
@@ -298 +473 @@
-                }
-                
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-                return $arguments;
-        }

trunk/classes/phing/tasks/ext/svn/SvnBaseTask.php

@@ -23 +23 @@
-
-/**
- Send a message by mail() 
+Base class for Subversion tasks
- *
-
-
-
-
-
+
+
+
+
+
+
- */
-abstract class SvnBaseTask extends Task
@@ -44 +45 @@
-        
-        private $svnArgs = array();
+        
+        private $svnSwitches = array();
+
+        private $toDir = "";
-
-        /**
@@ -105 +110 @@
-                return $this->svnPath;
-        }
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        /**
-         * Creates a VersionControl_SVN class based on $mode
@@ -162 +255 @@
-                
-                $tempArgs = array_merge($tempArgs, $args);
-
-
+
+
+
+
+
+
-                {
-                        return $output;

trunk/classes/phing/tasks/ext/svn/SvnExportTask.php

@@ -25 +25 @@
-/**
- * Exports/checks out a repository to a local directory
+ * with authentication 
- *
- * @author Michiel Rook <michiel.rook@gmail.com>
+ * @author Andrew Eddie <andrew.eddie@jamboworks.com> 
- * @version $Id$
- * @package phing.tasks.ext.svn
-
-
+
- */
-class SvnExportTask extends SvnBaseTask
-{
-        private $toDir = "";
-
-        /**
-         * Sets the path to export/checkout to
-         */
-        function setToDir($toDir)
-        {
-                $this->toDir = $toDir;
-        }
-
-        /**
-         * Returns the path to export/checkout to
-         */
-        function getToDir()
-        {
-                return $this->toDir;
-        }
-
-        /**
-         * The main entry point
@@ -61 +44 @@
-                $this->setup('export');
-                
-toDir
-
-toDir
+getToDir()
+
+getToDir()
-        }
-}

trunk/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html

@@ -167 +167 @@
-
-<h3>Example</h3>
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  &lt;comment&gt;A project encoded with the ionCube encoder.&lt;/comment&gt;
-&lt;/ioncubeencoder&gt;
@@ -186 +200 @@
-  </thead>
-  <tbody>
+    <tr>
+      <td>allowedserver</td>
+      <td>String</td>
+      <td>Restricts the encoded files to particular servers and/or domains.  Consult the IonCude documentation for more information.</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>binary</td>
+      <td>Boolean</td>
+      <td>Whether to save encoded files in binary format (default is ASCII format)</td>
+      <td>false</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>copy</td>
+      <td>String</td>
+      <td>Specifies files or directories to exclude from being encoded or encrypted and copy them to the target directory (separated by space).</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>encode</td>
+      <td>String</td>
+      <td>Specifies additional file patterns, files or directories to encode, or to reverse the effect of <em>copy</em></td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>encrypt</td>
+      <td>String</td>
+      <td>Specify files or directories (space separated list) that are to be encrypted.</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>expirein</td>
+      <td>String</td>
+      <td>Sets a period in seconds (s), minutes (m), hours (h) or days (d) after which the files expire.  Accepts: <em>500s</em> or <em>55m</em> or <em>24h</em> or <em>7d</em></td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>expireon</td>
+      <td>String</td>
+      <td>Sets a YYYY-MM-DD date to expire the files.</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>fromdir</td>
+      <td>String</td>
+      <td>Path containing source files</td>
+      <td>none</td>
+      <td>Yes</td>
+    </tr>
+    <tr>
+      <td>ignore</td>
+      <td>String</td>
+      <td>Set files and directories to ignore entirely and exclude from the target directory (separated by space).</td>
+      <td>none</td>
+      <td>Yes</td>
+    </tr>
+    <tr>
+      <td>ioncubepath</td>
+      <td>String</td>
+      <td>Path to the ionCube binaries</td>
+      <td>/usr/local/ioncube</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>keep</td>
+      <td>String</td>
+      <td>Set files and directories not to be ignored (separated by space)./td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>licensepath</td>
+      <td>String</td>
+      <td>Path to the license file that will be used by the encoded files</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>nodoccomments</td>
+      <td>String</td>
+      <td>Omits documents comments ( /** ... */ ) from the encoded files.</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>obfuscation-key</td>
+      <td>String</td>
+      <td>The obfuscation key must be supplied when using the obfuscate option</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    </tr>
+    <tr>
+      <td>obfuscate</td>
+      <td>String</td>
+      <td>The Encoder can obfuscate the names of global functions, the names of local variables in global functions, and line numbers.  Use either <em>all</em> or any of <em>functions</em>, <em>locals</em> or <em>linenos</em> separated by a space.</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>optimize</td>
+      <td>String</td>
+      <td>Controls the optimization of the encoded files, accepts either <em>more</em> or <em>max</em></td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>passphrase</td>
+      <td>String</td>
+      <td>The passphrase to use when encoding with a license file</td>
+      <td>none</td>
+      <td>No</td>
+    </tr>
-    <tr>
-      <td>phpversion</td>
@@ -194 +328 @@
-    </tr>
-    <tr>
-ioncubepath
-
-Path to the ionCube binaries
-/usr/local/ioncub
-
-
-
-binary
-Boolean
-Wether to save encoded files in binary format (default is ASCII format)
-fals
-No
+targetoption
+
+Option to use when target directory exists, accepts <em>replace</em>, <em>merge</em>, <em>update</em> and <em>rename</em>
+non
+
+
+
+todir
+String
+Path to save encoded files to
+non
+Yes
-    </tr>
-    <tr>
@@ -213 +347 @@
-      <td>false</td>
-      <td>No</td>
-    </tr>
-    <tr>
-      <td>optimize</td>
-      <td>String</td>
-      <td>Controls the optimization of the encoded files, accepts either <em>more</em> or <em>max</em></td>
-      <td>none</td>
-      <td>No</td>
-    </tr>
-    <tr>
-      <td>licensepath</td>
-      <td>String</td>
-      <td>Path to the license file that will be used by the encoded files</td>
-      <td>none</td>
-      <td>No</td>
-    </tr>
-    <tr>
-      <td>passphrase</td>
-      <td>String</td>
-      <td>The passphrase to use when encoding with a license file</td>
-      <td>none</td>
-      <td>No</td>
-    </tr>
-    <tr>
-      <td>targetoption</td>
-      <td>String</td>
-      <td>Option to use when target directory exists, accepts <em>replace</em>, <em>merge</em>, <em>update</em> and <em>rename</em></td>
-      <td>none</td>
-      <td>No</td>
-    </tr>
-    <tr>
-      <td>fromdir</td>
-      <td>String</td>
-      <td>Path containing source files</td>
-      <td>none</td>
-      <td>Yes</td>
-    </tr>
-    <tr>