ProgrammingError: extend IcingaException

refs #6931

library/Icinga/Application/Loader.php

@@ -39,11 +39,11 @@ class Loader
     public function registerNamespace($namespace, $directory)
     {
         if (!is_dir($directory)) {
-            throw new ProgrammingError(sprintf(
+            throw new ProgrammingError(
                 'Directory "%s" for namespace "%s" does not exist',
                 $directory,
                 $namespace
-            ));
+            );
         }
 
         $this->namespaces[$namespace] = $directory;

library/Icinga/Application/Modules/Manager.php

@@ -323,10 +323,8 @@ class Manager
         }
 
         throw new ProgrammingError(
-            sprintf(
+            'Trying to access uninstalled module dir: %s',
-                'Trying to access uninstalled module dir: %s',
+            $name
-                $name
-            )
         );
     }
 
@@ -392,10 +390,8 @@ class Manager
     {
         if (!$this->hasLoaded($name)) {
             throw new ProgrammingError(
-                sprintf(
+                'Cannot access module %s as it hasn\'t been loaded',
-                    'Cannot access module %s as it hasn\'t been loaded',
+                $name
-                    $name
-                )
             );
         }
         return $this->loadedModules[$name];

library/Icinga/Cli/Loader.php

@@ -332,7 +332,8 @@ class Loader
     {
         if (! $this->hasModule($module)) {
             throw new ProgrammingError(
-                sprintf('There is no such module: %s', $module)
+                'There is no such module: %s',
+                $module
             );
         }
     }
@@ -341,7 +342,8 @@ class Loader
     {
         if (! $this->hasCommand($command)) {
             throw new ProgrammingError(
-                sprintf('There is no such command: %s', $command)
+                'There is no such command: %s',
+                $command
             );
         }
     }
@@ -351,7 +353,9 @@ class Loader
         $this->assertModuleExists($module);
         if (! $this->hasModuleCommand($module, $command)) {
             throw new ProgrammingError(
-                sprintf("The module '%s' has no such command: %s", $module, $command)
+                'The module \'%s\' has no such command: %s',
+                $module,
+                $command
             );
         }
     }

library/Icinga/Data/Filter/Filter.php

@@ -34,9 +34,12 @@ abstract class Filter
         if ((string) $id === $this->getId()) {
             return $this;
         }
-        throw new ProgrammingError(sprintf(
+        throw new ProgrammingError(
-            'Trying to get invalid filter index "%s" from "%s" ("%s")', $id, $this, $this->id
+            'Trying to get invalid filter index "%s" from "%s" ("%s")',
-        ));
+            $id,
+            $this,
+            $this->id
+        );
     }
 
     public function getId()
@@ -136,7 +139,8 @@ abstract class Filter
             case '<=': return new FilterEqualOrLessThan($col, $op, $expression);
             case '!=': return new FilterNotEqual($col, $op, $expression);
             default: throw new ProgrammingError(
-                sprintf('There is no such filter sign: %s', $op)
+                'There is no such filter sign: %s',
+                $op
             );
         }
     }
@@ -188,7 +192,7 @@ abstract class Filter
                 $args = $args[0];
             }
         }
-        if (count($args) > 1) { 
+        if (count($args) > 1) {
             return new FilterNot(array(new FilterAnd($args)));
         } else {
             return new FilterNot($args);
@@ -203,7 +207,8 @@ abstract class Filter
             case 'NOT': return self::not($filters);
         }
         throw new ProgrammingError(
-            sprintf('"%s" is not a valid filter chain operator', $operator)
+            '"%s" is not a valid filter chain operator',
+            $operator
         );
     }
 

library/Icinga/Data/ResourceFactory.php

@@ -78,7 +78,7 @@ class ResourceFactory implements ConfigAwareFactory
     {
         if (!isset(self::$resources)) {
             throw new ProgrammingError(
-                "The ResourceFactory must be initialised by setting a config, before it can be used"
+                'The ResourceFactory must be initialised by setting a config, before it can be used'
             );
         }
     }

library/Icinga/Exception/ProgrammingError.php

@@ -8,6 +8,6 @@ namespace Icinga\Exception;
  * Class ProgrammingError
  * @package Icinga\Exception
  */
-class ProgrammingError extends \Exception
+class ProgrammingError extends IcingaException
 {
 }

library/Icinga/Protocol/Commandpipe/Command.php

@@ -138,7 +138,10 @@ abstract class Command
      */
     public function getHostgroupCommand($hostgroup)
     {
-        throw new ProgrammingError(get_class($this) . ' does not provide a hostgroup command');
+        throw new ProgrammingError(
+            '%s does not provide a hostgroup command',
+            get_class($this)
+        );
     }
 
     /**
@@ -150,7 +153,10 @@ abstract class Command
      */
     public function getServicegroupCommand($servicegroup)
     {
-        throw new ProgrammingError(get_class($this) . ' does not provide a servicegroup command');
+        throw new ProgrammingError(
+            '%s does not provide a servicegroup command',
+            get_class($this)
+        );
     }
 
     /**
@@ -163,6 +169,9 @@ abstract class Command
      */
     public function getGlobalCommand($instance = null)
     {
-        throw new ProgrammingError(getclass($this) . ' does not provide a global command');
+        throw new ProgrammingError(
+            '%s does not provide a global command',
+            getclass($this)
+        );
     }
 }

library/Icinga/Util/Format.php

@@ -95,7 +95,10 @@ class Format
             return '-';
         }
         if (! preg_match('~^\d+$~', $timestamp)) {
-            throw new ProgrammingError(sprintf('"%s" is not a number', $timestamp));
+            throw new ProgrammingError(
+                '"%s" is not a number',
+                $timestamp
+            );
         }
         $prefix = '';
         if ($diff < 0) {

library/Icinga/Web/Form.php

@@ -369,8 +369,8 @@ class Form extends Zend_Form
                 $element->setAttrib('class', $class);
             } else {
                 throw new ProgrammingError(
-                    'You need to add the element "' . $elementName . '" to' .
+                    'You need to add the element "%s" to the form before automatic submission can be enabled!',
-                    ' the form before automatic submission can be enabled!'
+                    $elementName
                 );
             }
         }

library/Icinga/Web/Hook.php

@@ -117,11 +117,9 @@ class Hook
         $base_class = self::$BASE_NS . ucfirst($name);
         if (!$instance instanceof $base_class) {
             throw new ProgrammingError(
-                sprintf(
+                '%s is not an instance of %s',
-                    '%s is not an instance of %s',
+                get_class($instance),
-                    get_class($instance),
+                $base_class
-                    $base_class
-                )
             );
         }
     }
@@ -185,7 +183,10 @@ class Hook
     public static function registerClass($name, $key, $class)
     {
         if (!class_exists($class)) {
-            throw new ProgrammingError('"' . $class . '" is not an existing class');
+            throw new ProgrammingError(
+                '"%s" is not an existing class',
+                $class
+            );
         }
 
         if (!isset(self::$hooks[$name])) {
@@ -207,7 +208,10 @@ class Hook
     public static function registerObject($name, $key, $object)
     {
         if (!is_object($object)) {
-            throw new ProgrammingError('"' . $object . '" is not an instantiated class');
+            throw new ProgrammingError(
+                '"%s" is not an instantiated class',
+                $object
+            );
         }
 
         if (!isset(self::$instances[$name])) {

library/Icinga/Web/Menu.php

@@ -277,7 +277,10 @@ class Menu implements RecursiveIterator
     public function getSubMenu($id)
     {
         if (false === $this->hasSubMenu($id)) {
-            throw new ProgrammingError('Tried to get invalid sub menu "' . $id . '"');
+            throw new ProgrammingError(
+                'Tried to get invalid sub menu "%s"',
+                $id
+            );
         }
 
         return $this->subMenus[$id];

library/Icinga/Web/Notification.php

@@ -53,10 +53,8 @@ class Notification
             )
         )) {
             throw new ProgrammingError(
-                sprintf(
+                '"%s" is not a valid notification type',
-                    '"%s" is not a valid notification type',
+                $type
-                    $type
-                )
             );
         }
 

library/Icinga/Web/Url.php

@@ -120,7 +120,10 @@ class Url
         }
 
         if (!is_string($url)) {
-            throw new ProgrammingError(sprintf('url "%s" is not a string', $url));
+            throw new ProgrammingError(
+                'url "%s" is not a string',
+                $url
+            );
         }
 
         $urlObject = new Url();

library/Icinga/Web/View.php

@@ -103,10 +103,8 @@ class View extends Zend_View_Abstract
     {
         if ($this->hasHelperFunction($name)) {
             throw new ProgrammingError(
-                sprintf(
+                'Cannot assign the same helper function twice: "%s"',
-                    'Cannot assign the same helper function twice: "%s"',
+                $name
-                    $name
-                )
             );
         }
 

library/Icinga/Web/View/helpers/url.php

@@ -94,10 +94,10 @@ $this->addHelperFunction('attributeToString', function ($key, $value)
 {
     // TODO: Doublecheck this!
     if (! preg_match('~^[a-zA-Z0-9-]+$~', $key)) {
-        throw new ProgrammingError(sprintf(
+        throw new ProgrammingError(
             'Trying to set an invalid HTML attribute name: %s',
             $key
-        ));
+        );
     }
 
     return sprintf(

library/Icinga/Web/Widget.php

@@ -38,10 +38,8 @@ class Widget
 
         if (! class_exists($class)) {
             throw new ProgrammingError(
-                sprintf(
+                'There is no such widget: %s',
-                    'There is no such widget: %s',
+                $name
-                    $name
-                )
             );
         }
 

library/Icinga/Web/Widget/AbstractWidget.php

@@ -52,11 +52,9 @@ abstract class AbstractWidget
         }
 
         throw new ProgrammingError(
-            sprintf(
+            'Trying to get invalid "%s" property for %s',
-                'Trying to get invalid "%s" property for %s',
+            $key,
-                $key,
+            get_class($this)
-                get_class($this)
-            )
         );
     }
 
@@ -78,14 +76,12 @@ abstract class AbstractWidget
         }
 
         throw new ProgrammingError(
-            sprintf(
+            'Trying to set invalid "%s" property in %s. Allowed are: %s',
-                'Trying to set invalid "%s" property in %s. Allowed are: %s',
+            $key,
-                $key,
+            get_class($this),
-                get_class($this),
+            empty($this->properties)
-                empty($this->properties)
                 ? 'none'
                 : implode(', ', array_keys($this->properties))
-            )
         );
     }
 

library/Icinga/Web/Widget/Dashboard.php

@@ -224,7 +224,8 @@ class Dashboard extends AbstractWidget
     {
         if (! array_key_exists($name, $this->panes)) {
             throw new ProgrammingError(
-                sprintf('Trying to retrieve invalid dashboard pane "%s"', $name)
+                'Trying to retrieve invalid dashboard pane "%s"',
+                $name
             );
         }
         return $this->panes[$name];

library/Icinga/Web/Widget/Dashboard/Pane.php

@@ -105,7 +105,10 @@ class Pane extends AbstractWidget
         if ($this->hasComponent($title)) {
             return $this->components[$title];
         }
-        throw new ProgrammingError(sprintf('Trying to access invalid component: %s', $title));
+        throw new ProgrammingError(
+            'Trying to access invalid component: %s',
+            $title
+        );
     }
 
     /**

library/Icinga/Web/Widget/Tabs.php

@@ -154,10 +154,8 @@ EOT;
     {
         if ($this->has($name)) {
             throw new ProgrammingError(
-                sprintf(
+                'Cannot add a tab named "%s" twice"',
-                    'Cannot add a tab named "%s" twice"',
+                $name
-                    $name
-                )
             );
         }
         return $this->set($name, $tab);

modules/monitoring/library/Monitoring/Backend.php

@@ -148,7 +148,10 @@ public function getResource()
     {
         $viewClass = '\\Icinga\\Module\\Monitoring\\DataView\\' . ucfirst($viewName);
         if (!class_exists($viewClass)) {
-            throw new ProgrammingError('DataView ' . ucfirst($viewName) . ' does not exist');
+            throw new ProgrammingError(
+                'DataView %s does not exist',
+                ucfirst($viewName)
+            );
         }
         return $viewClass;
     }
@@ -175,7 +178,9 @@ public function getResource()
             . 'Query';
         if (!class_exists($queryClass)) {
             throw new ProgrammingError(
-                'Query "' . ucfirst($queryName) . '" does not exist for backend ' . ucfirst($this->type)
+                'Query "%s" does not exist for backend %s',
+                ucfirst($queryName),
+                ucfirst($this->type)
             );
         }
         return $queryClass;

modules/monitoring/library/Monitoring/Backend/Ido/Query/IdoQuery.php

@@ -442,7 +442,11 @@ abstract class IdoQuery extends DbQuery
         } elseif ($this->isCustomVar($alias)) {
             $this->requireCustomvar($alias);
         } else {
-            throw new ProgrammingError(sprintf('%s : Got invalid column: %s', get_called_class(), $alias));
+            throw new ProgrammingError(
+                '%s : Got invalid column: %s',
+                get_called_class(),
+                $alias
+            );
         }
         return $this;
     }
@@ -476,7 +480,8 @@ abstract class IdoQuery extends DbQuery
     {
         if ($this->hasJoinedVirtualTable($name)) {
             throw new ProgrammingError(
-                sprintf('IDO query virtual table conflict with "%s"', $name)
+                'IDO query virtual table conflict with "%s"',
+                $name
             );
         }
         return $this;
@@ -499,10 +504,8 @@ abstract class IdoQuery extends DbQuery
             $this->$func();
         } else {
             throw new ProgrammingError(
-                sprintf(
+                'Cannot join "%s", no such table found',
-                    'Cannot join "%s", no such table found',
+                $table
-                    $table
-                )
             );
         }
         $this->joinedVirtualTables[$table] = true;
@@ -581,10 +584,8 @@ abstract class IdoQuery extends DbQuery
         // TODO: Improve this:
         if (! preg_match('~^_(host|service)_([a-zA-Z0-9_]+)$~', $customvar, $m)) {
             throw new ProgrammingError(
-                sprintf(
+                'Got invalid custom var: "%s"',
-                    'Got invalid custom var: "%s"',
+                $customvar
-                    $customvar
-                )
             );
         }
         return array($m[1], $m[2]);

modules/monitoring/library/Monitoring/Timeline/TimeEntry.php

@@ -79,7 +79,9 @@ class TimeEntry
                 $entry->{$methodName}($value);
             } else {
                 throw new ProgrammingError(
-                    'Method "' . $methodName . '" does not exist on object of type "' . __CLASS__ . '"'
+                    'Method "%s" does not exist on object of type "%s"',
+                    $methodName,
+                    __CLASS__
                 );
             }
         }