flack / midgard-portable

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;

api/midgard/collector.php

Doc Comments +4 added lines

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

src/api/object.php

Doc Comments +11 added lines, -1 removed lines

@@ -117,6 +117,9 @@ 
         return null;
     }
 
+    /**
+     * @param integer $id
+     */
     public function get_by_id($id)
     {
         $entity = connection::get_em()->find(get_class($this), $id);
@@ -150,6 +153,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $guid
+     */
     public function get_by_guid($guid)
     {
         if (!mgd_is_guid($guid)) {
@@ -492,6 +498,7 @@ 
     }
 
     /**
+     * @param integer $up
      * @return QueryBuilder
      */
     protected function get_uniquefield_query($classname, $field, $part, $upfield, $up)
@@ -593,7 +600,7 @@ 
     /**
      * @param string $domain
      * @param string $name
-     * @param mixed $value
+     * @param string $value
      * @return boolean
      */
     public function set_parameter($domain, $name, $value)
@@ -799,6 +806,9 @@ 
         return new \midgard_reflection_property(get_called_class());
     }
 
+    /**
+     * @param string $guid
+     */
     public function set_guid($guid)
     {
         parent::__set('guid', $guid);

api/midgard/storage.php

Doc Comments +8 added lines

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

api/midgard/connection.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
 
     private $replication_enabled = true;
 
+    /**
+     * @return integer
+     */
     public static function get_instance()
     {
         if (self::$instance === null) {

api/midgard/object/class.php

Doc Comments +3 added lines

@@ -96,6 +96,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

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

api/midgard/replicator.php

Doc Comments +11 added lines, -2 removed lines

@@ -240,7 +240,7 @@ 
     }
 
     /**
-     * @return boolean Indicating success
+     * @return boolean|null Indicating success
      */
     public static function import_from_xml($xml, $force = false)
     {
@@ -264,6 +264,9 @@ 
         $blob->write_content($blob->content);
     }
 
+    /**
+     * @return string|null
+     */
     private static function resolve_link_id(ClassMetadata $cm, dbobject $object, $name)
     {
         if ($object->$name == 0) {
@@ -339,7 +342,7 @@ 
      *
      * @param SimpleXMLElement $node
      * @param boolean $force
-     * @return dbobject
+     * @return blob
      */
     private static function blob_from_xml(SimpleXMLElement $node, $force)
     {
@@ -350,6 +353,9 @@ 
         return $blob;
     }
 
+    /**
+     * @param string $guid
+     */
     private static function get_object_action($guid)
     {
         $result = connection::get_em()
@@ -376,6 +382,9 @@ 
         }
     }
 
+    /**
+     * @return string|null
+     */
     private static function convert_value($value)
     {
         if ($value instanceof midgard_datetime) {

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)
@@ -122,6 +125,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $key
+     */
     private function convert_to_storage($key, $value)
     {
         if (is_bool($value)) {