PHPDoc and $child->canShow Method again

bmarwell · Sep 4, 2015 · a16a231 · a16a231
1 parent 594c208
commit a16a231
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 4 deletions.
diff --git a/src/JsonLD/JsonLD.php b/src/JsonLD/JsonLD.php
@@ -21,6 +21,11 @@
 abstract class JsonLD
 {
 
+    /**
+     * Creates a JsonLD-Objekt with type set to $jsonldtype.
+     * @param String $jsonldtype
+     * @param bool|FALSE $addContext
+     */
     function __construct($jsonldtype, $addContext = FALSE)
     {
         Log::addDebugLog("creating JsonLD-object");
@@ -29,7 +34,6 @@ function __construct($jsonldtype, $addContext = FALSE)
         $id = "@id";
 
         if ($addContext === true) {
-            Log::addDebugLog("adding context…");
             $this->$context = "http://schema.org";
         }
 

diff --git a/src/JsonLD/JsonLDTools.php b/src/JsonLD/JsonLDTools.php
@@ -259,7 +259,7 @@ public static function addChildrenFromRecord($person, $record)
         }
 
         foreach ($children as $child) {
-            if (!($child->canShowName())) {
+            if (!$child->canShow()) {
                 continue;
             }
             $childPerson = new Person();

diff --git a/src/JsonLD/Person.php b/src/JsonLD/Person.php
@@ -16,14 +16,16 @@
 
 namespace bmarwell\WebtreesModules\jsonld;
 
-use Fisharebest\Webtrees\Log;
 use Fisharebest\Webtrees\Place;
 
 /**
  * Person for serializing into json-ld. Vars have name from schema.org.
  */
 class Person extends JsonLD
 {
+    /**
+     * @var
+     */
     public $name;
 
     /**
@@ -38,6 +40,10 @@ class Person extends JsonLD
      * @var String the last name or family name.
      */
     public $familyName;
+    /**
+     * Date of Birth in ISO.
+     * @var String $birthDate;
+     */
     public $birthDate;
 
     /**
@@ -58,10 +64,27 @@ class Person extends JsonLD
      */
     public $deathDate;
 
+    /**
+     * E-Mail adress as string.
+     * @var String $email
+     */
     public $email;
+    /**
+     * @var String $url
+     */
     public $url;
+    /**
+     * @var array $address
+     */
     public $address = array();
+    /**
+     * U or M or F.
+     * @var string Gender
+     */
     public $gender = "U";
+    /**
+     * @var array
+     */
     public $parents = array();
 
     /**
@@ -75,22 +98,33 @@ class Person extends JsonLD
      */
     public $image;
 
+    /**
+     * @param bool|FALSE $addContext
+     */
     function __construct($addContext = FALSE)
     {
-        Log::addDebugLog("creating person, context is $addContext");
         parent::__construct("Person", $addContext);
     }
 
+    /**
+     * @param Person $address
+     */
     function addAddress($address)
     {
         array_push($this->address, $address);
     }
 
+    /**
+     * @param Person $parent
+     */
     function addParent($parent)
     {
         array_push($this->parents, $parent);
     }
 
+    /**
+     * @param Person $child
+     */
     function addChild($child)
     {
         array_push($this->children, $child);

diff --git a/src/JsonLD/jsonld_Place.php b/src/JsonLD/jsonld_Place.php
@@ -36,6 +36,10 @@ class jsonld_Place extends JsonLD
      */
     public $address;
 
+    /**
+     * Construct using context?
+     * @param bool|FALSE $addContext
+     */
     function __construct($addContext = FALSE)
     {
         parent::__construct("Place", $addContext);