Added documentation to readme.

Added docblocks.
ScriptFUSION · Oct 9, 2016 · c4bed21 · c4bed21
1 parent be9bed5
commit c4bed21
Show file tree

Hide file tree

Showing 7 changed files with 348 additions and 7 deletions.
diff --git a/README.md b/README.md
diff --git a/src/Porter/Connector/CachingConnector.php b/src/Porter/Connector/CachingConnector.php
@@ -6,10 +6,19 @@
 use ScriptFUSION\Porter\Cache\MemoryCache;
 use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 
+/**
+ * Caches remote data using PSR-6-compliant objects.
+ */
 abstract class CachingConnector implements Connector, CacheToggle
 {
+    /**
+     * @var CacheItemPoolInterface
+     */
     private $cache;
 
+    /**
+     * @var bool
+     */
     private $cacheEnabled = true;
 
     public function __construct(CacheItemPoolInterface $cache = null)
@@ -57,6 +66,6 @@ public function isCacheEnabled()
 
     private function hash(array $structure)
     {
-        return sha1(json_encode($structure));
+        return json_encode($structure);
     }
 }
diff --git a/src/Porter/Mapper/Strategy/SubImport.php b/src/Porter/Mapper/Strategy/SubImport.php
@@ -13,8 +13,7 @@ class SubImport implements Strategy, PorterAware
     private $specificationOrCallback;
 
     /**
-     * Initializes this instance with the specified import specification or
-     * the specification callback.
+     * Initializes this instance with the specified import specification or specification callback.
      *
      * @param ImportSpecification|callable $specificationOrCallback Import specification
      *     or specification callback.

diff --git a/src/Porter/Net/Soap/SoapConnector.php b/src/Porter/Net/Soap/SoapConnector.php
@@ -6,6 +6,9 @@
 use ScriptFUSION\Porter\Type\ObjectType;
 use ScriptFUSION\Retry\ErrorHandler\ExponentialBackoffErrorHandler;
 
+/**
+ * Fetches data from a SOAP service.
+ */
 class SoapConnector extends CachingConnector
 {
     private $client;

diff --git a/src/Porter/Net/Soap/SoapOptions.php b/src/Porter/Net/Soap/SoapOptions.php
@@ -98,7 +98,9 @@ public function getProxyPassword()
     /**
      * Extracts a list of SOAP Client options only.
      *
-     * @return array HTTP context options.
+     * @return array SOAP context options.
+     *
+     * @see http://php.net/manual/en/soapclient.soapclient.php
      */
     public function extractSoapClientOptions()
     {

diff --git a/src/Porter/Porter.php b/src/Porter/Porter.php
@@ -20,14 +20,29 @@
 use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 
+/**
+ * Imports data according to an ImportSpecification.
+ */
 class Porter
 {
+    /**
+     * @var Provider[]
+     */
     private $providers;
 
+    /**
+     * @var ProviderFactory
+     */
     private $providerFactory;
 
+    /**
+     * @var CollectionMapper
+     */
     private $mapper;
 
+    /**
+     * @var CacheAdvice
+     */
     private $defaultCacheAdvice;
 
     public function __construct()
@@ -67,7 +82,7 @@ public function import(ImportSpecification $specification)
      *
      * @param ImportSpecification $specification Import specification.
      *
-     * @return mixed Data.
+     * @return array Record.
      *
      * @throws ImportException More than one record was imported.
      */

diff --git a/src/Porter/Specification/ImportSpecification.php b/src/Porter/Specification/ImportSpecification.php
@@ -5,6 +5,9 @@
 use ScriptFUSION\Porter\Cache\CacheAdvice;
 use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
 
+/**
+ * Specifies which resource to import, how to import it, and how it should be transformed.
+ */
 class ImportSpecification
 {
     /** @var ProviderResource */