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);

api/midgard/connection.php

Doc Comments +3 added lines

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

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))

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

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)

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))

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))

src/query.php

Doc Comments +6 added lines

@@ -239,6 +239,9 @@ 
         }
     }
 
+    /**
+     * @param string $targetclass
+     */
     protected function add_collection_join($current_table, $targetclass)
     {
         if (!array_key_exists($targetclass, $this->join_tables))
@@ -250,6 +253,9 @@ 
         return $this->join_tables[$targetclass];
     }
 
+    /**
+     * @param \midgard_reflection_property $mrp
+     */
     protected function add_join($current_table, $mrp, $property)
     {
         $targetclass = $mrp->get_link_name($property);