add doc blocks

Author: kossmac

remote.php

@@ -16,19 +16,44 @@ public function __construct()
         $this->helper = plugin_load('helper', 'farmer');
     }
 
-    public function getHostname() {
+    /**
+     * Get the configured farm host
+     *
+     * @return string
+     */
+    public function getFarmhost(): string
+    {
         return $this->helper->getConfig()['base']['farmhost'];
     }
 
-    public function getBaseDomain() {
+    /**
+     * Get the configured base domain of the farmer
+     * This could be an empty string, then farmhost will be used to determine an animal url
+     *
+     * @return string
+     */
+    public function getBaseDomain(): string
+    {
         return $this->helper->getConfig()['base']['basedomain'];
     }
 
-    public function listAnimals() {
+    /**
+     * Get a list of all animal names
+     *
+     * @return array
+     */
+    public function listAnimals(): array
+    {
         return $this->helper->getAllAnimals();
     }
 
-    public function listAnimalUrls() {
+    /**
+     * Get a list of all animal urls
+     *
+     * @return array
+     */
+    public function listAnimalUrls(): array
+    {
         foreach($this->helper->getAllAnimals() as $animal) {
             $animalUrls[] = $this->helper->getAnimalURL($animal);
         }