Code improvements and docblocks

Firesphere · May 10, 2018 · bc9e29b · bc9e29b
1 parent 2c67c1a
commit bc9e29b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 11 deletions.
diff --git a/src/extensions/SiteConfigExtension.php b/src/extensions/SiteConfigExtension.php
@@ -2,8 +2,6 @@
 
 namespace Firesphere\PartialUserforms\Extensions;
 
-use DateInterval;
-use DateTime;
 use Firesphere\PartialUserforms\Jobs\PartialSubmissionJob;
 use Firesphere\PartialUserforms\Services\DateService;
 use SilverStripe\Core\Injector\Injector;

diff --git a/src/jobs/PartialSubmissionJob.php b/src/jobs/PartialSubmissionJob.php
@@ -2,8 +2,6 @@
 
 namespace Firesphere\PartialUserforms\Jobs;
 
-use DateInterval;
-use DateTime;
 use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
 use Firesphere\PartialUserforms\Models\PartialFormSubmission;
 use Firesphere\PartialUserforms\Services\DateService;
@@ -148,8 +146,8 @@ protected function getParents()
     }
 
     /**
-     * @param $file
-     * @param $form
+     * @param string $file
+     * @param UserDefinedForm $form
      */
     protected function buildCSV($file, $form)
     {
@@ -169,9 +167,9 @@ protected function buildCSV($file, $form)
     }
 
     /**
-     * @param $form
-     * @param $submissions
-     * @param $resource
+     * @param UserDefinedForm $form
+     * @param PartialFormSubmission $submissions
+     * @param resource $resource
      */
     protected function processSubmissions($form, $submissions, $resource)
     {
@@ -193,6 +191,9 @@ protected function processSubmissions($form, $submissions, $resource)
         }
     }
 
+    /**
+     * Send out the email(s)
+     */
     protected function sendEmail()
     {
         /** @var Email $mail */
@@ -285,6 +286,9 @@ public function addAddress($address)
         }
     }
 
+    /**
+     * @return SiteConfig
+     */
     public function getConfig()
     {
         return $this->config;

diff --git a/tests/helpers/SiteConfigHelper.php b/tests/helpers/SiteConfigHelper.php
@@ -11,7 +11,7 @@
  */
 class SiteConfigHelper
 {
-    public static function createSiteConfig($addresses = null, $from = null, $send = true, $cleanup = true)
+    public static function setupSiteConfig($addresses = null, $from = null, $send = true, $cleanup = true)
     {
         $config = SiteConfig::current_site_config();
         $config->SendMailTo = $addresses;

diff --git a/tests/unit/PartialSubmissionTaskTest.php b/tests/unit/PartialSubmissionTaskTest.php
@@ -9,7 +9,6 @@
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Security;
-use SilverStripe\SiteConfig\SiteConfig;
 use Symbiote\QueuedJobs\Services\QueuedJobService;
 
 class PartialSubmissionTaskTest extends SapphireTest