flack / midgard-portable

api/midgard/collector.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
 
     private $value_properties = array();
 
+    /**
+     * @param string $class
+     */
     function __construct($class, $field, $value)
     {
         parent::__construct($class);

Spacing +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
         $parsed = $this->parse_constraint_name($property);
 
         // for properties like up.name
-        if (   strpos($property, ".") !== false
+        if (strpos($property, ".") !== false
             && !(strpos($property, "metadata") === 0))
         {
             return $parsed['name'] . " as " . str_replace(".", "_", $property);
@@ -154,7 +154,7 @@ 
      */
     public function get($key)
     {
-        if (   !$this->_has_results()
+        if (!$this->_has_results()
             || !isset($this->_results[$key]))
         {
             return false;

Braces +2 added lines, -4 removed lines

@@ -53,8 +53,7 @@ 
         try
         {
             $property_select = $this->build_property_select($property);
-        }
-        catch (exception $e)
+        } catch (exception $e)
         {
             return false;
         }
@@ -103,8 +102,7 @@ 
             try
             {
                 $properties[] = $this->build_property_select($this->key_property);
-            }
-            catch (exception $e)
+            } catch (exception $e)
             {
                 throw new exception('Property "' . $this->key_property . '" not found in "' . $this->classname . '"', exception::INVALID_PROPERTY);
             }

api/midgard/connection.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
         //??
     }
 
+    /**
+     * @return integer
+     */
     public static function get_instance()
     {
         if (self::$instance === null)

Spacing +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
         return is_object($this->config);
     }
 
-    public function connect($signal, $callback, $userdata = '???' )
+    public function connect($signal, $callback, $userdata = '???')
     {
 
     }
@@ -123,7 +123,7 @@ 
         return connection::get_user();
     }
 
-    public function set_loglevel($level, $callback = '???' )
+    public function set_loglevel($level, $callback = '???')
     {
         if (!in_array($level, $this->available_loglevels))
         {

api/midgard/object/class.php

Doc Comments +3 added lines

@@ -106,6 +106,9 @@
         return true;
     }
 
+    /**
+     * @param string $guid
+     */
     public static function get_object_by_guid($guid)
     {
         if (!mgd_is_guid($guid))

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
         {
             throw exception::object_purged();
         }
-        if (    !$include_deleted
+        if (!$include_deleted
              && $result["object_action"] == subscriber::ACTION_DELETE)
         {
             throw exception::object_deleted();

Braces +3 added lines, -6 removed lines

@@ -24,8 +24,7 @@ 
         try
         {
             $result = $qb->getQuery()->getSingleResult();
-        }
-        catch (\Doctrine\ORM\NoResultException $e)
+        } catch (\Doctrine\ORM\NoResultException $e)
         {
             $result = null;
         }
@@ -67,8 +66,7 @@ 
         try
         {
             $classname = self::resolve_classname($guid, true);
-        }
-        catch (exception $e)
+        } catch (exception $e)
         {
             return false;
         }
@@ -95,8 +93,7 @@ 
         {
             $om = new objectmanager(connection::get_em());
             $om->undelete($entity);
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;

api/midgard/query/builder.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
         }
     }
 
+    /**
+     * @param string $operator
+     */
     public function add_constraint($name, $operator, $value)
     {
         try

Braces +2 added lines, -4 removed lines

@@ -15,8 +15,7 @@ 
         try
         {
             return parent::add_constraint_with_property($name, $operator, $value);
-        }
-        catch (exception $e)
+        } catch (exception $e)
         {
             return false;
         }
@@ -27,8 +26,7 @@ 
         try
         {
             return parent::add_constraint($name, $operator, $value);
-        }
-        catch (exception $e)
+        } catch (exception $e)
         {
             return false;
         }

api/midgard/replicator.php

Doc Comments +11 added lines, -2 removed lines

@@ -274,7 +274,7 @@ 
     }
 
     /**
-     * @return boolean Indicating success
+     * @return boolean|null Indicating success
      */
     public static function import_from_xml($xml, $force = false)
     {
@@ -302,6 +302,9 @@ 
         $blob->write_content($blob->content);
     }
 
+    /**
+     * @return string|null
+     */
     private static function resolve_link_id(ClassMetadata $cm, dbobject $object, $name)
     {
         if ($object->$name == 0)
@@ -387,7 +390,7 @@ 
      *
      * @param SimpleXMLElement $node
      * @param boolean $force
-     * @return dbobject
+     * @return blob
      */
     private static function blob_from_xml(SimpleXMLElement $node, $force)
     {
@@ -398,6 +401,9 @@ 
         return $blob;
     }
 
+    /**
+     * @param string $guid
+     */
     private static function get_object_action($guid)
     {
         $result = connection::get_em()
@@ -425,6 +431,9 @@ 
         }
     }
 
+    /**
+     * @return string|null
+     */
     private static function convert_value($value)
     {
         if ($value instanceof midgard_datetime)

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use midgard\portable\api\error\exception;
 use midgard\portable\api\blob;
-use midgard\portable\storage\objectmanager;
 use Doctrine\ORM\NoResultException;
 
 class midgard_replicator

Spacing +3 added lines, -3 removed lines

@@ -225,14 +225,14 @@ 
                 break;
         }
 
-        if (   $dbobject->id > 0
+        if ($dbobject->id > 0
             && $dbobject->metadata->revised >= $object->metadata->revised)
         {
             midgard_connection::get_instance()->set_error(exception::OBJECT_IMPORTED);
             return false;
         }
 
-        if (   $dbobject->metadata->deleted
+        if ($dbobject->metadata->deleted
             && !$object->metadata->deleted)
         {
             if (!midgard_object_class::undelete($dbobject->guid))
@@ -241,7 +241,7 @@ 
             }
             $dbobject->metadata_deleted = false;
         }
-        else if (   !$dbobject->metadata->deleted
+        else if (!$dbobject->metadata->deleted
                  && $object->metadata->deleted)
         {
             return $dbobject->delete();

Braces +6 added lines, -12 removed lines

@@ -112,8 +112,7 @@ 
             if (strpos($name, 'metadata_') === 0)
             {
                 $metadata[substr($name, 9)] = $object->$name;
-            }
-            else
+            } else
             {
                 $node->addChild($name, self::convert_value($object->$name));
             }
@@ -159,13 +158,11 @@ 
                 if ($node->getName() == 'midgard_blob')
                 {
                     $ret[] = self::blob_from_xml($node, $force);
-                }
-                else
+                } else
                 {
                     $ret[] = self::object_from_xml($node, $force);
                 }
-            }
-            catch (\Exception $e)
+            } catch (\Exception $e)
             {
                 connection::log()->warning($e->getMessage());
             }
@@ -240,8 +237,7 @@ 
                 return false;
             }
             $dbobject->metadata_deleted = false;
-        }
-        else if (   !$dbobject->metadata->deleted
+        } else if (   !$dbobject->metadata->deleted
                  && $object->metadata->deleted)
         {
             return $dbobject->delete();
@@ -284,8 +280,7 @@ 
             if ($object instanceof blob)
             {
                 self::import_blob($object, $force);
-            }
-            else
+            } else
             {
                 self::import_object($object, $force);
             }
@@ -367,8 +362,7 @@ 
                 try
                 {
                     $value = self::resolve_link_guid($cm, $field, $value);
-                }
-                catch (NoResultException $e)
+                } catch (NoResultException $e)
                 {
                     if (!$force)
                     {

api/midgard/storage.php

Doc Comments +8 added lines

@@ -61,6 +61,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $classname
+     */
     public static function create_class_storage($classname)
     {
         $em = connection::get_em();
@@ -95,6 +98,11 @@ 
         $generator->generateProxyClass($cm, $filename);
     }
 
+    /**
+     * @param Doctrine\ORM\EntityManagerInterface $em
+     *
+     * @return ClassMetadata
+     */
     private static function get_cm($em, $classname)
     {
         if (!class_exists($classname))

Braces +2 added lines, -4 removed lines

@@ -107,16 +107,14 @@
         try
         {
             return $factory->getMetadataFor($classname);
-        }
-        catch (MappingException $e)
+        } catch (MappingException $e)
         {
             // add namespace
             $classname = $em->getConfiguration()->getEntityNamespace("midgard") . '\\' . $classname;
             try
             {
                 return $factory->getMetadataFor($classname);
-            }
-            catch (MappingException $e)
+            } catch (MappingException $e)
             {
                 // check for merged classes (duplicate tablenames)
                 $classname = get_class(new $classname);

src/api/blob.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
         return null;
     }
 
+    /**
+     * @param string $content
+     */
     public function write_content($content)
     {
         return file_put_contents($this->get_path(), $content) !== false;

src/api/config.php

Doc Comments +6 added lines

@@ -30,6 +30,9 @@ 
     public $cachedir = '/var/cache/midgard2';
     public $gdathreads = false;
 
+    /**
+     * @param string $path
+     */
     public function read_file_at_path($path)
     {
         if (   !file_exists($path)
@@ -136,6 +139,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $key
+     */
     private function convert_to_storage($key, $value)
     {
         if (is_bool($value))

Spacing +3 added lines, -4 removed lines

@@ -32,7 +32,7 @@ 
 
     public function read_file_at_path($path)
     {
-        if (   !file_exists($path)
+        if (!file_exists($path)
             || !is_readable($path))
         {
             return false;
@@ -47,8 +47,7 @@ 
     // TODO: find out if this could be moved to read_data()
     private function apply_config(array $config)
     {
-        $mapping = array
-        (
+        $mapping = array(
             'type' => 'dbtype',
             'name' => 'database',
             'username' => 'dbuser',
@@ -166,7 +165,7 @@ 
         {
             foreach ($subdirs as $subdir)
             {
-                if (   !is_dir($this->blobdir . '/' . $dir . '/' . $subdir)
+                if (!is_dir($this->blobdir . '/' . $dir . '/' . $subdir)
                     && !mkdir($this->blobdir . '/' . $dir . '/' . $subdir, 0777, true))
                 {
                     return false;

Braces +3 added lines, -6 removed lines

@@ -80,8 +80,7 @@ 
         if (!$user)
         {
             $prefix = '/etc/midgard2/conf.d';
-        }
-        else
+        } else
         {
             $prefix = getenv('HOME') . '/.midgard2/conf.d';
         }
@@ -93,8 +92,7 @@ 
         if (!$user)
         {
             $prefix = '/etc/midgard2/conf.d';
-        }
-        else
+        } else
         {
             $prefix = getenv('HOME') . '/.midgard2/conf.d';
         }
@@ -141,8 +139,7 @@ 
         if (is_bool($value))
         {
             $value = ($value) ? 'true' : 'false';
-        }
-        else if ($value === '')
+        } else if ($value === '')
         {
             $value = '""';
         }

src/api/object.php

Doc Comments +20 added lines, -4 removed lines

@@ -64,6 +64,9 @@ 
         parent::__set($field, $value);
     }
 
+    /**
+     * @param string $field
+     */
     public function __get($field)
     {
         if (   $field === 'metadata'
@@ -111,6 +114,9 @@ 
         return null;
     }
 
+    /**
+     * @param integer $id
+     */
     public function get_by_id($id)
     {
         $entity = connection::get_em()->find(get_class($this), $id);
@@ -151,6 +157,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $guid
+     */
     public function get_by_guid($guid)
     {
         if (!mgd_is_guid($guid))
@@ -526,7 +535,8 @@ 
     }
 
     /**
-     * @return int
+     * @param integer $up
+     * @return \Doctrine\ORM\QueryBuilder
      */
     protected function get_uniquefield_query($classname, $field, $part, $upfield, $up)
     {
@@ -619,6 +629,9 @@ 
         }
     }
 
+    /**
+     * @param string $value
+     */
     public function set_parameter($domain, $name, $value)
     {
         $constraints = array
@@ -712,7 +725,7 @@ 
      *
      * @param array $constraints
      * @param boolean $delete_blob
-     * @return boolean False if one or more attachments couldn't be deleted
+     * @return integer False if one or more attachments couldn't be deleted
      * @todo Implement delete_blob & return value
      */
     public function purge_attachments(array $constraints = array(), $delete_blob = true)
@@ -817,6 +830,9 @@ 
         return new \midgard_reflection_property(get_called_class());
     }
 
+    /**
+     * @param string $guid
+     */
     public function set_guid($guid)
     {
         parent::__set('guid', $guid);
@@ -829,8 +845,8 @@ 
 
     /**
      * helper function for managing the isapproved and islocked metadata properties
-     * @param string $propertyName the property to manage (either isapproved or islocked)
-     * @param bool $newval
+     * @param string $action
+     * @param boolean $value
      * @return boolean
      */
     private function manage_meta_property($action, $value)

Indentation +1 added lines, -1 removed lines

@@ -883,7 +883,7 @@
 
     public function approve()
     {
-       return $this->manage_meta_property("approve", true);
+        return $this->manage_meta_property("approve", true);
     }
 
     public function is_approved()

Spacing +14 added lines, -17 removed lines

@@ -66,7 +66,7 @@ 
 
     public function __get($field)
     {
-        if (   $field === 'metadata'
+        if ($field === 'metadata'
             && property_exists($this, 'metadata')
             && $this->metadata === null)
         {
@@ -92,7 +92,7 @@ 
             if ($this->$candidate !== null)
             {
                 //Proxies become stale if the object itself is detached, so we have to re-fetch
-                if (   $this->$candidate instanceof \Doctrine\ORM\Proxy\Proxy
+                if ($this->$candidate instanceof \Doctrine\ORM\Proxy\Proxy
                     && $this->$candidate->__isInitialized())
                 {
                     try
@@ -121,7 +121,7 @@ 
         }
         // According to Doctrine documentation, proxies should be transparent, but in practice,
         // there will be problems if we don't force-load
-        if (   $entity instanceof \Doctrine\ORM\Proxy\Proxy
+        if ($entity instanceof \Doctrine\ORM\Proxy\Proxy
             && !$entity->__isInitialized())
         {
             try
@@ -176,7 +176,7 @@ 
             exception::duplicate();
             return false;
         }
-        if (   !$this->is_unique()
+        if (!$this->is_unique()
             || !$this->check_parent())
         {
             return false;
@@ -238,7 +238,7 @@ 
             midgard_connection::get_instance()->set_error(MGD_ERR_INVALID_PROPERTY_VALUE);
             return false;
         }
-        if (   $check_dependencies
+        if ($check_dependencies
             && $this->has_dependents())
         {
             exception::has_dependants();
@@ -282,8 +282,7 @@ 
         $conditions = $qb->expr()->andX();
         if ($this->id)
         {
-            $parameters = array
-            (
+            $parameters = array(
                 'id' => $this->id
             );
             $conditions->add($qb->expr()->neq('c.id', ':id'));
@@ -337,7 +336,7 @@ 
     {
         $this->initialize();
 
-        if (   empty($this->cm->midgard['parentfield'])
+        if (empty($this->cm->midgard['parentfield'])
             || empty($this->cm->midgard['parent']))
         {
             return true;
@@ -357,7 +356,7 @@ 
 
         foreach ($this->cm->fieldMappings as $name => $field)
         {
-            if (   $field['midgard:midgard_type'] == translator::TYPE_GUID
+            if ($field['midgard:midgard_type'] == translator::TYPE_GUID
                 && !empty($this->$name)
                 && !mgd_is_guid($this->$name))
             {
@@ -395,7 +394,7 @@ 
             $stat = ($results > 0);
         }
 
-        if (   !$stat
+        if (!$stat
             && !empty($this->cm->midgard['childtypes']))
         {
             foreach ($this->cm->midgard['childtypes'] as $typename => $parentfield)
@@ -534,8 +533,7 @@ 
         $qb->from($classname, 'c');
         $conditions = $qb->expr()->andX();
         $conditions->add($qb->expr()->eq('c.' . $field, ':' . $field));
-        $parameters = array
-        (
+        $parameters = array(
             $field => $part
         );
 
@@ -621,10 +619,9 @@ 
 
     public function set_parameter($domain, $name, $value)
     {
-        $constraints = array
-        (
-            array ('domain', '=', $domain),
-            array ('name', '=', $name),
+        $constraints = array(
+            array('domain', '=', $domain),
+            array('name', '=', $name),
         );
         $params = $this->get_collection('midgard_parameter')->find($this->guid, $constraints);
 
@@ -765,7 +762,7 @@ 
             exception::not_exists();
             return false;
         }
-        if (   $check_dependencies
+        if ($check_dependencies
             && $this->has_dependents())
         {
             exception::has_dependants();

Braces +19 added lines, -38 removed lines

@@ -33,8 +33,7 @@ 
             if (is_int($id))
             {
                 $this->get_by_id($id);
-            }
-            else if (is_string($id))
+            } else if (is_string($id))
             {
                 $this->get_by_guid($id);
             }
@@ -98,8 +97,7 @@ 
                     try
                     {
                         $this->$candidate->get_by_id($this->$candidate->id);
-                    }
-                    catch (exception $e)
+                    } catch (exception $e)
                     {
                         connection::log()->error('Failed to refresh parent from proxy: ' . $e->getMessage());
                         return null;
@@ -127,8 +125,7 @@ 
             try
             {
                 $entity->__load();
-            }
-            catch (\Doctrine\ORM\EntityNotFoundException $e)
+            } catch (\Doctrine\ORM\EntityNotFoundException $e)
             {
                 throw exception::object_purged();
             }
@@ -189,8 +186,7 @@ 
         {
             $om = new objectmanager(connection::get_em());
             $om->create($this);
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;
@@ -216,8 +212,7 @@ 
         {
             $om = new objectmanager(connection::get_em());
             $om->update($this);
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;
@@ -257,8 +252,7 @@ 
         {
             $om = new objectmanager(connection::get_em());
             $om->delete($this);
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;
@@ -312,8 +306,7 @@ 
             if ($this->{$this->cm->midgard['upfield']} === null)
             {
                 $conditions->add($qb->expr()->isNull('c.' . $this->cm->midgard['upfield']));
-            }
-            else
+            } else
             {
                 $conditions->add($qb->expr()->eq('c.' . $this->cm->midgard['upfield'], ':' . $this->cm->midgard['upfield']));
                 $parameters[$this->cm->midgard['upfield']] = $this->{$this->cm->midgard['upfield']};
@@ -480,14 +473,12 @@ 
             $parentclass = $this->cm->fullyQualifiedClassName($this->cm->midgard['parent']);
             $parentfield = $parent_cm->midgard['upfield'];
             $upfield = $this->cm->midgard['parentfield'];
-        }
-        else if (!empty($this->cm->midgard['upfield']))
+        } else if (!empty($this->cm->midgard['upfield']))
         {
             $parentclass = get_class($this);
             $upfield = $this->cm->midgard['upfield'];
             $parentfield = $upfield;
-        }
-        else
+        } else
         {
             return false;
         }
@@ -546,8 +537,7 @@ 
                 ->add($qb->expr()->isNull('c.' . $upfield))
                 ->add($qb->expr()->eq('c.' . $upfield, '0'));
             $conditions->add($empty_conditions);
-        }
-        else
+        } else
         {
             $conditions->add($qb->expr()->eq('c.' . $upfield, ':' . $upfield));
             $parameters[$upfield] = $up;
@@ -612,8 +602,7 @@ 
         try
         {
             return $qb->getQuery()->getOneOrNullResult(Query::HYDRATE_SINGLE_SCALAR);
-        }
-        catch (\Doctrine\ORM\NoResultException $e)
+        } catch (\Doctrine\ORM\NoResultException $e)
         {
             return null;
         }
@@ -638,8 +627,7 @@ 
                     $stat = $param->delete();
                 }
                 return $stat;
-            }
-            else
+            } else
             {
                 exception::not_exists();
                 return false;
@@ -668,8 +656,7 @@ 
             }
             midgard_connection::get_instance()->set_error(MGD_ERR_OK);
             return true;
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;
@@ -740,8 +727,7 @@ 
             $om->create($att);
             midgard_connection::get_instance()->set_error(MGD_ERR_OK);
             return $att;
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return null;
@@ -776,13 +762,11 @@ 
         {
             $om = new objectmanager(connection::get_em());
             $om->purge($this);
-        }
-        catch (\Doctrine\ORM\EntityNotFoundException $e)
+        } catch (\Doctrine\ORM\EntityNotFoundException $e)
         {
             exception::not_exists();
             return false;
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             exception::internal($e);
             return false;
@@ -844,12 +828,10 @@ 
         if ($action == 'lock')
         {
             $flag = 'islocked';
-        }
-        else if ($action == 'approve')
+        } else if ($action == 'approve')
         {
             $flag = 'isapproved';
-        }
-        else
+        } else
         {
             throw new exception('Unsupported action ' . $action);
         }
@@ -869,8 +851,7 @@ 
             {
                 $om = new objectmanager(connection::get_em());
                 $om->{$action}($this);
-            }
-            catch (\Exception $e)
+            } catch (\Exception $e)
             {
                 exception::internal($e);
                 return false;