Merge branch 'namespaces' into nextgen

Part-DB · Aug 29, 2017 · b357e6e · b357e6e
2 parents 9a4533e + dae51b6
commit b357e6e
Show file tree

Hide file tree

Showing 43 changed files with 2,972 additions and 2,932 deletions.
diff --git a/edit_attachement_types.php b/edit_attachement_types.php
@@ -124,7 +124,7 @@
                     throw new Exception(_('Es ist kein Dateityp markiert oder es trat ein Fehler auf!'));
                 }
 
-                $attachements = $selected_attachement_type->get_attachements();
+                $attachements = $selected_attachement_type->get_attachements_for_type();
                 $count = count($attachements);
 
                 if ($count > 0) {

diff --git a/edit_part_info.php b/edit_part_info.php
diff --git a/inc/lib.debug.php b/inc/lib.debug.php
@@ -200,7 +200,7 @@ function delete_debug_log_file()
  * @param array|null $types     @li here you can supply an array of all log types (strings) you want to get
  *                              @li NULL if you want to get ALL log elements
  *
- * @retval array     log elements (array-like)
+ * @return array     log elements (array-like)
  *
  * @throws Exception if there was an error (maybe no file or no read permissions)
  */

diff --git a/inc/lib.functions.php b/inc/lib.functions.php
@@ -131,7 +131,7 @@ function money_format($format, $number)
  * str_getcsv()
  */
 if (! function_exists('str_getcsv')) {
-    function str_getcsv($str, $delim=',', $enclose='"', $preserve=false)
+    function str_getcsv($str, $delim = ',', $enclose = '"', $preserve = false)
     {
         $resArr = array();
         $n = 0;

diff --git a/inc/lib.php b/inc/lib.php
@@ -419,7 +419,7 @@ function save_config()
     $content .= '    //$manual_config[\'money_format\'][\'POSIX\']                = \'%!n €\';'."\n";
     $content .= '    //$manual_config[\'DOCUMENT_ROOT\']                        = \'/var/www\';'."\n";
     $content .= array_to_php_lines($manual_config, $manual_config, '    $manual_config', false);
-    $content .= "\n?>";
+    $content .= "\n";
 
     if (! ($fp = fopen(BASE.'/data/config.php', 'wb'))) {
         throw new Exception('Die Datei "config.php" konnte nicht beschrieben werden. Überprüfen Sie, ob genügend Rechte vorhanden sind.');

diff --git a/lib/Attachement.php b/lib/Attachement.php
@@ -499,7 +499,7 @@ public static function add(
             throw new Exception(_('$element ist kein Objekt!'));
         }
 
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,

diff --git a/lib/AttachementType.php b/lib/AttachementType.php
@@ -76,7 +76,7 @@ public function __construct(&$database, &$current_user, &$log, $id, $db_data = n
      *
      * @throws Exception if there was an error
      */
-    public function get_attachements()
+    public function get_attachements_for_type()
     {
         // the attribute $this->attachements is used from class "AttachementsContainingDBELement"
         if (! is_array($this->attachements)) {
@@ -138,7 +138,7 @@ public static function get_count(&$database)
      */
     public static function add(&$database, &$current_user, &$log, $name, $parent_id)
     {
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,

diff --git a/lib/Base/Company.php b/lib/Base/Company.php
@@ -61,9 +61,9 @@ abstract class Company extends PartsContainingDBElement implements IAPIModel
      * @throws Exception        if there is no such element in the database
      * @throws Exception        if there was an error
      */
-    public function __construct(&$database, &$current_user, &$log, $tablename, $id)
+    public function __construct(&$database, &$current_user, &$log, $tablename, $id, $data = null)
     {
-        parent::__construct($database, $current_user, $log, $tablename, $id);
+        parent::__construct($database, $current_user, $log, $tablename, $id, $data);
 
         if ($id == 0) {
             // this is the root node

diff --git a/lib/Base/DBElement.php b/lib/Base/DBElement.php
@@ -342,11 +342,11 @@ public static function check_values_validity(&$database, &$current_user, &$log,
      *                                          @li example: @code
      *                                              array(['name'] => 'abcd', ['parent_id'] => 123, ...) @endcode
      *
-     * @retval object       the created object (e.g. Device, Part, Category, ...)
+     * @return static       the created object (e.g. Device, Part, Category, ...)
      *
      * @throws Exception if the values are not valid / the combination of values is not valid
      */
-    public static function add(&$database, &$current_user, &$log, $tablename, $new_values)
+    protected static function add_via_array(&$database, &$current_user, &$log, $tablename, $new_values)
     {
         if (!$database instanceof Database) {
             throw new Exception(_('$database ist kein gültiges Database-Objekt!'));

diff --git a/lib/Base/NamedDBElement.php b/lib/Base/NamedDBElement.php
@@ -128,7 +128,7 @@ public static function check_values_validity(&$database, &$current_user, &$log,
     }
 
     /**
-     * Search elements by name
+     * Search elements by name in the given table
      *
      * @param Database  &$database              reference to the database object
      * @param User      &$current_user          reference to the user which is logged in
@@ -142,7 +142,7 @@ public static function check_values_validity(&$database, &$current_user, &$log,
      *
      * @throws Exception if there was an error
      */
-    public static function search(&$database, &$current_user, &$log, $tablename, $keyword, $exact_match)
+    protected static function search_table(&$database, &$current_user, &$log, $tablename, $keyword, $exact_match)
     {
         if (strlen($keyword) == 0) {
             return array();
@@ -166,4 +166,5 @@ public static function search(&$database, &$current_user, &$log, $tablename, $ke
 
         return $objects;
     }
+
 }
diff --git a/lib/Base/PartsContainingDBElement.php b/lib/Base/PartsContainingDBElement.php
@@ -75,9 +75,9 @@ abstract class PartsContainingDBElement extends StructuralDBElement
      * @throws Exception if there is no such element in the database
      * @throws Exception if there was an error
      */
-    public function __construct(&$database, &$current_user, &$log, $tablename, $id)
+    public function __construct(&$database, &$current_user, &$log, $tablename, $id, $data = null)
     {
-        parent::__construct($database, $current_user, $log, $tablename, $id);
+        parent::__construct($database, $current_user, $log, $tablename, $id, $data);
     }
 
     /**
@@ -161,43 +161,8 @@ public function delete($delete_recursive = false, $delete_files_from_hdd = false
      *
      * @throws Exception if there was an error
      */
-    public function get_parts($parts_rowname, $recursive = false, $hide_obsolete_and_zero = false)
+    public function get_table_parts($parts_rowname, $recursive = false, $hide_obsolete_and_zero = false)
     {
-        /*
-            if ( ! is_array($this->parts))
-            {
-                $this->parts = array();
-
-                $query = 'SELECT id FROM parts WHERE '.$parts_rowname.'=? ORDER BY name, description';
-                $query_data = $this->database->query($query, array($this->get_id()));
-
-                foreach ($query_data as $row)
-                    $this->parts[] = new Part($this->database, $this->current_user, $this->log, $row['id']);
-            }
-
-            $parts = $this->parts;
-
-            if ($hide_obsolete_and_zero)
-            {
-                // remove obsolete parts from array
-                $parts = array_values(array_filter($parts, function($part) {return (( ! $part->get_obsolete()) || ($part->get_instock() > 0));}));
-            }
-
-            if ($recursive)
-            {
-                $subelements = $this->get_subelements(false);
-
-                foreach ($subelements as $element) {
-                    $i = $element->get_id();
-
-                    $parts = array_merge($parts, $element->get_parts(true, $hide_obsolete_and_zero));
-                }
-                usort($parts, 'PartsContainingDBElement::usort_compare'); // Sort all parts by their names and descriptions
-            }
-
-            return $parts;
-            */
-
         $subelements = array();
 
         if ($recursive) {
@@ -249,6 +214,8 @@ public function get_parts($parts_rowname, $recursive = false, $hide_obsolete_and
         return $parts;
     }
 
+    public abstract function get_parts($recursive = false, $hide_obsolete_and_zero = false);
+
     /**
      * Compare function for "usort()"
      *

diff --git a/lib/Category.php b/lib/Category.php
@@ -36,7 +36,7 @@
  * All elements of this class are stored in the database table "categories".
  * @author kami89
  */
-class Category extends Base\PartsContainingDBElement implements Interfaces\IAPIModel
+class Category extends Base\PartsContainingDBElement implements Interfaces\IAPIModel, Interfaces\ISearchable
 {
     /********************************************************************************
      *
@@ -59,7 +59,7 @@ class Category extends Base\PartsContainingDBElement implements Interfaces\IAPIM
      */
     public function __construct(&$database, &$current_user, &$log, $id, $data = null)
     {
-        parent::__construct($database, $current_user, $log, 'categories', $id, false, $data);
+        parent::__construct($database, $current_user, $log, 'categories', $id, $data);
     }
 
     /********************************************************************************
@@ -335,6 +335,7 @@ public function get_partname_regex_raw($including_parents = false, $show_escape
     /**
      * Gets the regex of this Category.
      * @param bool $including_parents
+     * @return string The regex.
      */
     public function get_partname_regex($including_parents = true)
     {
@@ -378,7 +379,7 @@ public function check_partname($name, $including_parents = true)
      */
     public function get_parts($recursive = false, $hide_obsolete_and_zero = false)
     {
-        return parent::get_parts('id_category', $recursive, $hide_obsolete_and_zero);
+        return parent::get_table_parts('id_category', $recursive, $hide_obsolete_and_zero);
     }
 
     /********************************************************************************
@@ -547,7 +548,7 @@ public static function add(
         $default_description = "",
         $default_comment = ""
     ) {
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,
@@ -568,7 +569,7 @@ public static function add(
      */
     public static function search(&$database, &$current_user, &$log, $keyword, $exact_match = false)
     {
-        return parent::search($database, $current_user, $log, 'categories', $keyword, $exact_match);
+        return parent::search_table($database, $current_user, $log, 'categories', $keyword, $exact_match);
     }
 
     /**

diff --git a/lib/Database.php b/lib/Database.php
@@ -26,6 +26,7 @@
 namespace PartDB;
 
 /** @noinspection PhpIncludeInspection */
+use DebugBar\DataCollector\PDO\TraceablePDO;
 use Exception;
 use PartDB\Tools\PDBDebugBar;
 use PDO;
@@ -170,7 +171,7 @@ public function __construct()
         }
 
         if (PDBDebugBar::is_activated()) {
-            $this->pdo = new \DebugBar\DataCollector\PDO\TraceablePDO($this->pdo);
+            $this->pdo = new TraceablePDO($this->pdo);
             PDBDebugBar::getInstance()->registerPDO($this->pdo);
         }
     }

diff --git a/lib/Device.php b/lib/Device.php
@@ -65,7 +65,7 @@ class Device extends Base\PartsContainingDBElement
      */
     public function __construct(&$database, &$current_user, &$log, $id, $data = null)
     {
-        parent::__construct($database, $current_user, $log, 'devices', $id, false, $data);
+        parent::__construct($database, $current_user, $log, 'devices', $id, $data);
 
         if ($id == 0) {
             // this is the root node
@@ -271,7 +271,7 @@ public function get_order_only_missing_parts()
      *
      * @throws Exception if there was an error
      */
-    public function get_parts($recursive = false)
+    public function get_parts($recursive = false, $hide_obsolet_and_zero = false)
     {
         if (! is_array($this->parts)) {
             $this->parts = array();
@@ -500,7 +500,7 @@ public static function get_count(&$database)
      */
     public static function add(&$database, &$current_user, &$log, $name, $parent_id)
     {
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,

diff --git a/lib/DevicePart.php b/lib/DevicePart.php
@@ -444,7 +444,7 @@ public static function add(
         }
 
         // there is no such DevicePart, so we will create it
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,

diff --git a/lib/Footprint.php b/lib/Footprint.php
@@ -35,7 +35,7 @@
  * All elements of this class are stored in the database table "footprints".
  * @author kami89
  */
-class Footprint extends Base\PartsContainingDBElement implements Interfaces\IAPIModel
+class Footprint extends Base\PartsContainingDBElement implements Interfaces\IAPIModel, Interfaces\ISearchable
 {
     /********************************************************************************
      *
@@ -58,7 +58,7 @@ class Footprint extends Base\PartsContainingDBElement implements Interfaces\IAPI
      */
     public function __construct(&$database, &$current_user, &$log, $id, $data = null)
     {
-        parent::__construct($database, $current_user, $log, 'footprints', $id, false, $data);
+        parent::__construct($database, $current_user, $log, 'footprints', $id, $data);
 
         if ($id == 0) {
             // this is the root node
@@ -117,7 +117,7 @@ public function get_3d_filename($absolute = true)
      */
     public function get_parts($recursive = false, $hide_obsolete_and_zero = false)
     {
-        return parent::get_parts('id_footprint', $recursive, $hide_obsolete_and_zero);
+        return parent::get_table_parts('id_footprint', $recursive, $hide_obsolete_and_zero);
     }
 
     /**
@@ -340,7 +340,7 @@ public static function get_broken_3d_filename_footprints(&$database, &$current_u
      */
     public static function add(&$database, &$current_user, &$log, $name, $parent_id, $filename = '', $filename_3d = '')
     {
-        return parent::add(
+        return parent::add_via_array(
             $database,
             $current_user,
             $log,
@@ -356,7 +356,7 @@ public static function add(&$database, &$current_user, &$log, $name, $parent_id,
      */
     public static function search(&$database, &$current_user, &$log, $keyword, $exact_match = false)
     {
-        return parent::search($database, $current_user, $log, 'footprints', $keyword, $exact_match);
+        return parent::search_table($database, $current_user, $log, 'footprints', $keyword, $exact_match);
     }
 
     /**

diff --git a/lib/Interfaces/ISearchable.php b/lib/Interfaces/ISearchable.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: janhb
+ * Date: 29.08.2017
+ * Time: 14:25
+ */
+
+namespace PartDB\Interfaces;
+
+
+interface ISearchable
+{
+    /**
+     * Search elements by name.
+     *
+     * @param Database  &$database              reference to the database object
+     * @param User      &$current_user          reference to the user which is logged in
+     * @param Log       &$log                   reference to the Log-object
+     * @param string    $keyword                the search string
+     * @param boolean   $exact_match            @li If true, only records which matches exactly will be returned
+     *                                          @li If false, all similar records will be returned
+     *
+     * @return array    all found elements as a one-dimensional array of objects,
+     *                  sorted by their names
+     *
+     * @throws Exception if there was an error
+     */
+    public static function search(&$database, &$current_user, &$log, $keyword, $exact_match);
+}