Consistent usage of to string (#913)

phingofficial · May 11, 2018 · 4d1b68a · 4d1b68a
1 parent 0d9e10b
commit 4d1b68a
Showing 42 changed files with 121 additions and 138 deletions.
diff --git a/classes/phing/BuildException.php b/classes/phing/BuildException.php
@@ -121,6 +121,6 @@ public function getLocation()
     public function setLocation(Location $loc)
     {
         $this->location = $loc;
-        $this->message = $loc->toString() . ': ' . $this->message;
+        $this->message = (string) $loc . ': ' . $this->message;
     }
 }
diff --git a/classes/phing/Phing.php b/classes/phing/Phing.php
@@ -183,20 +183,18 @@ public static function start($args, array $additionalUserProperties = null)
                 $exitCode = 0;
             } catch (ExitStatusException $ese) {
                 $exitCode = $ese->getCode();
-                if ($exitCode != 0) {
+                if ($exitCode !== 0) {
                     self::handleLogfile();
                     throw $ese;
                 }
             }
         } catch (BuildException $exc) {
             // avoid printing output twice: self::printMessage($exc);
-        } catch (Exception $exc) {
-            echo $exc->getTraceAsString();
+        } catch (Throwable $exc) {
             self::printMessage($exc);
+        } finally {
+            self::handleLogfile();
         }
-
-        // everything fine, shutdown
-        self::handleLogfile();
         self::statusExit($exitCode);
     }
 
@@ -221,7 +219,7 @@ public static function printMessage(Exception $t)
             self::initializeOutputStreams();
         }
         if (self::getMsgOutputLevel() >= Project::MSG_VERBOSE) {
-            self::$err->write($t->__toString() . PHP_EOL);
+            self::$err->write((string) $t . PHP_EOL);
         } else {
             self::$err->write($t->getMessage() . PHP_EOL);
         }

diff --git a/classes/phing/Project.php b/classes/phing/Project.php
@@ -795,7 +795,7 @@ public function topoSort($rootTarget)
 
         $retHuman = "";
         for ($i = 0, $_i = count($ret); $i < $_i; $i++) {
-            $retHuman .= $ret[$i]->toString() . " ";
+            $retHuman .= (string) $ret[$i] . " ";
         }
         $this->log("Build sequence for target '$rootTarget' is: $retHuman", Project::MSG_VERBOSE);
 
@@ -817,7 +817,7 @@ public function topoSort($rootTarget)
 
         $retHuman = "";
         for ($i = 0, $_i = count($ret); $i < $_i; $i++) {
-            $retHuman .= $ret[$i]->toString() . " ";
+            $retHuman .= (string) $ret[$i] . " ";
         }
         $this->log("Complete build sequence is: $retHuman", Project::MSG_VERBOSE);
 
@@ -1083,7 +1083,7 @@ public function fireTaskFinished($task, $exception)
      * @param $message
      * @param $priority
      */
-    public function fireMessageLoggedEvent($event, $message, $priority)
+    public function fireMessageLoggedEvent(BuildEvent $event, $message, $priority)
     {
         $event->setMessage($message, $priority);
         foreach ($this->listeners as $listener) {

diff --git a/classes/phing/Target.php b/classes/phing/Target.php
@@ -308,17 +308,6 @@ public function getLogSkipped()
         return $this->logSkipped;
     }
 
-    /**
-     * Returns a string representation of this target. In our case it
-     * simply returns the target name field
-     *
-     * @return string The string representation of this target
-     */
-    public function toString()
-    {
-        return (string) $this;
-    }
-
     /**
      * Returns a string representation of this target. In our case it
      * simply returns the target name field

diff --git a/classes/phing/dispatch/DispatchUtils.php b/classes/phing/dispatch/DispatchUtils.php
@@ -58,11 +58,7 @@ public static function main($task)
                     $c = new ReflectionClass($dispatchable);
                     $actionM = $c->getMethod($mName);
                     $o = $actionM->invoke($dispatchable);
-                    if (method_exists($o, 'toString')) {
-                        $methodName = trim($o->toString());
-                    } else {
-                        $methodName = trim((string) $o);
-                    }
+                    $methodName = trim((string) $o);
                     if (empty($methodName)) {
                         throw new ReflectionException();
                     }

diff --git a/classes/phing/listener/XmlLogger.php b/classes/phing/listener/XmlLogger.php
@@ -241,7 +241,7 @@ public function taskStarted(BuildEvent $event)
 
         $taskElement = $this->doc->createElement(XmlLogger::TASK_TAG);
         $taskElement->setAttribute(XmlLogger::NAME_ATTR, $task->getTaskName());
-        $taskElement->setAttribute(XmlLogger::LOCATION_ATTR, $task->getLocation()->toString());
+        $taskElement->setAttribute(XmlLogger::LOCATION_ATTR, (string) $task->getLocation());
 
         $this->timesStack[] = Phing::currentTimeMillis();
         $this->elementStack[] = $taskElement;

diff --git a/classes/phing/parser/Location.php b/classes/phing/parser/Location.php
@@ -83,7 +83,7 @@ public function getColumnNumber()
      *
      * @return string the string representation of this Location object
      */
-    public function toString()
+    public function __toString()
     {
         $buf = "";
         if ($this->fileName !== null) {
@@ -96,12 +96,4 @@ public function toString()
 
         return (string) $buf;
     }
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->toString();
-    }
 }
diff --git a/classes/phing/system/io/PhingFile.php b/classes/phing/system/io/PhingFile.php
@@ -1100,16 +1100,6 @@ public function equals($obj)
         return false;
     }
 
-    /**
-     * Backwards compatibility - @see __toString()
-     *
-     * @return string
-     */
-    public function toString()
-    {
-        return $this->__toString();
-    }
-
     /**
      * Return string representation of the object
      *

diff --git a/classes/phing/system/lang/EventObject.php b/classes/phing/system/lang/EventObject.php
@@ -46,7 +46,7 @@ public function getSource()
     }
 
     /** Returns a String representation of this EventObject.*/
-    public function toString()
+    public function __toString()
     {
         if (method_exists($this->source, "toString")) {
             return get_class($this) . "[source=" . $this->source->toString() . "]";

diff --git a/classes/phing/system/util/Properties.php b/classes/phing/system/util/Properties.php
@@ -111,7 +111,7 @@ protected function outVal($val)
      *
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
         $buf = "";
         foreach ($this->properties as $key => $item) {
@@ -147,7 +147,7 @@ public function store(PhingFile $file = null, $header = null)
             if ($header !== null) {
                 $fw->write("# " . $header . PHP_EOL);
             }
-            $fw->write($this->toString());
+            $fw->write((string) $this);
             $fw->close();
         } catch (IOException $e) {
             throw new IOException("Error writing property file: " . $e->getMessage());

diff --git a/classes/phing/tasks/ext/property/PathToFileSet.php b/classes/phing/tasks/ext/property/PathToFileSet.php
@@ -104,7 +104,7 @@ public function main()
         }
         if (!$this->dir->isDirectory()) {
             throw new BuildException(
-                $this->dir->toString() . " is not a directory");
+                (string) $this->dir . " is not a directory");
         }
         $path = $this->getProject()->getReference($this->pathRefId);
         if ($path == null) {

diff --git a/classes/phing/tasks/system/MatchingTask.php b/classes/phing/tasks/system/MatchingTask.php
@@ -217,9 +217,9 @@ public function hasSelectors()
      *
      * @return int The number of selectors in this container
      */
-    public function selectorCount()
+    public function count()
     {
-        return $this->fileset->selectorCount();
+        return $this->fileset->count();
     }
 
     /**

diff --git a/classes/phing/tasks/system/PropertyTask.php b/classes/phing/tasks/system/PropertyTask.php
@@ -255,7 +255,7 @@ public function getOverride()
     /**
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
         return (string) $this->value;
     }
@@ -351,8 +351,6 @@ public function main()
 
                 if ($referencedObject instanceof Exception) {
                     $reference = $referencedObject->getMessage();
-                } elseif (method_exists($referencedObject, 'toString')) {
-                    $reference = $referencedObject->toString();
                 } else {
                     $reference = (string) $referencedObject;
                 }
@@ -364,8 +362,6 @@ public function main()
 
                     if ($referencedObject instanceof Exception) {
                         $reference = $referencedObject->getMessage();
-                    } elseif (method_exists($referencedObject, 'toString')) {
-                        $reference = $referencedObject->toString();
                     } else {
                         $reference = (string) $referencedObject;
                     }

diff --git a/classes/phing/tasks/system/TempFile.php b/classes/phing/tasks/system/TempFile.php
@@ -173,6 +173,6 @@ public function main()
             $this->deleteOnExit,
             $this->createFile
         );
-        $this->getProject()->setNewProperty($this->property, $tmpFile->toString());
+        $this->getProject()->setNewProperty($this->property, (string) $tmpFile);
     }
 }
diff --git a/classes/phing/tasks/system/condition/IsFileSelected.php b/classes/phing/tasks/system/condition/IsFileSelected.php
@@ -51,7 +51,7 @@ public function setBaseDir(PhingFile $baseDir)
      */
     public function validate()
     {
-        if ($this->selectorCount() != 1) {
+        if ($this->count() != 1) {
             throw new BuildException("Only one selector allowed");
         }
         parent::validate();

diff --git a/classes/phing/types/AbstractFileSet.php b/classes/phing/types/AbstractFileSet.php
@@ -339,9 +339,11 @@ protected function setupDirectoryScanner(DirectoryScanner $ds, Project $p)
             $this->getRef($p)->setupDirectoryScanner($ds, $p);
             return;
         }
-        if ($ds === null) {
-            throw new BuildException("DirectoryScanner cannot be null");
-        }
+
+        $stk[] = $this;
+        $this->dieOnCircularReference($stk, $p);
+        array_pop($stk);
+
         // FIXME - pass dir directly when dirscanner supports File
         $ds->setBasedir($this->dir->getPath());
 
@@ -353,12 +355,16 @@ protected function setupDirectoryScanner(DirectoryScanner $ds, Project $p)
         $ds->setExcludes($this->defaultPatterns->getExcludePatterns($p));
 
         $p->log(
-            "FileSet: Setup file scanner in dir " . (string) $this->dir . " with " . $this->defaultPatterns->toString(),
+            $this->getDataTypeName() . ": Setup file scanner in dir " . (string) $this->dir . " with " . (string) $this->defaultPatterns,
             Project::MSG_DEBUG
         );
 
         if ($ds instanceof SelectorScanner) {
-            $ds->setSelectors($this->getSelectors($p));
+            $selectors = $this->getSelectors($p);
+            foreach ($selectors as $selector) {
+                $p->log((string) $selector . PHP_EOL, Project::MSG_DEBUG);
+            }
+            $ds->setSelectors($selectors);
         }
 
         if ($this->useDefaultExcludes) {
@@ -367,6 +373,25 @@ protected function setupDirectoryScanner(DirectoryScanner $ds, Project $p)
         $ds->setCaseSensitive($this->isCaseSensitive);
     }
 
+    public function dieOnCircularReference(&$stk, Project $p = null)
+    {
+        if ($this->checked) {
+            return;
+        }
+        if ($this->isReference()) {
+            parent::dieOnCircularReference($stk, $p);
+        } else {
+            foreach ($this->selectorsList as $fileSelector) {
+                if ($fileSelector instanceof DataType) {
+                    static::pushAndInvokeCircularReferenceCheck($fileSelector, $stk, $p);
+                }
+            }
+            foreach  ($this->additionalPatterns as $ps) {
+                static::pushAndInvokeCircularReferenceCheck($ps, $stk, $p);
+            }
+            $this->setChecked(true);
+        }
+    }
 
     /**
      * Performs the check for circular references and returns the
@@ -431,11 +456,11 @@ public function hasPatterns()
      * @throws Exception
      * @return int The number of selectors in this container
      */
-    public function selectorCount()
+    public function count()
     {
         if ($this->isReference() && $this->getProject() !== null) {
             try {
-                return $this->getRef($this->getProject())->selectorCount();
+                return $this->getRef($this->getProject())->count();
             } catch (Exception $e) {
                 throw $e;
             }
@@ -509,4 +534,22 @@ public function getIterator(...$options): \ArrayIterator
     }
 
     abstract protected function getFiles(...$options);
+
+    public function __toString()
+    {
+        try {
+            if ($this->isReference()) {
+                return (string) $this->getRef($this->getProject());
+            }
+            $stk[] = $this;
+            $this->dieOnCircularReference($stk, $this->getProject());
+            $ds = $this->getDirectoryScanner($this->getProject());
+            $files = $ds->getIncludedFiles();
+            $result = implode(';', $files);
+        } catch (BuildException $e) {
+            $result = '';
+        }
+
+        return $result;
+    }
 }
diff --git a/classes/phing/types/DataType.php b/classes/phing/types/DataType.php
@@ -37,7 +37,7 @@ class DataType extends ProjectComponent
      *
      * @var Reference $ref
      */
-    public $ref = null;
+    private $ref;
 
     /**
      * Are we sure we don't hold circular references?

diff --git a/classes/phing/types/ExcludesNameEntry.php b/classes/phing/types/ExcludesNameEntry.php
@@ -72,7 +72,7 @@ public function getName()
      *
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
         return $this->name;
     }

diff --git a/classes/phing/types/PatternSet.php b/classes/phing/types/PatternSet.php
@@ -413,7 +413,7 @@ private function readFiles(Project $p)
     /**
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
 
         // We can't compile includeList into array because, toString() does
@@ -427,7 +427,7 @@ public function toString()
         } else {
             $includes = "";
             foreach ($this->includeList as $ne) {
-                $includes .= $ne->toString() . ",";
+                $includes .= (string) $ne . ",";
             }
             $includes = rtrim($includes, ",");
         }
@@ -437,7 +437,7 @@ public function toString()
         } else {
             $excludes = "";
             foreach ($this->excludeList as $ne) {
-                $excludes .= $ne->toString() . ",";
+                $excludes .= (string) $ne . ",";
             }
             $excludes = rtrim($excludes, ",");
         }

diff --git a/classes/phing/types/PatternSetNameEntry.php b/classes/phing/types/PatternSetNameEntry.php
@@ -105,7 +105,7 @@ public function valid(Project $project)
      * Gets a string representation of this pattern.
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
         $buf = $this->name;
         if (($this->ifCond !== null) || ($this->unlessCond !== null)) {

diff --git a/classes/phing/types/PropertyValue.php b/classes/phing/types/PropertyValue.php
@@ -59,7 +59,7 @@ public function getValue()
     /**
      * @return string
      */
-    public function toString()
+    public function __toString()
     {
         return $this->getValue();
     }