Set all docblocks.

Author: Lucas Michot

src/Credentials.php

@@ -10,29 +10,42 @@ class Credentials
 {
     const CONFIG_PREFIX = '___credentials_';
 
-    /** @var Encrypter */
+    /**
+     * The encrypter.
+     *
+     * @var \Illuminate\Contracts\Encryption\Encrypter
+     */
     private $encrypter;
 
-    /** @var array */
+    /**
+     * The decrpyted values array.
+     *
+     * @var array
+     */
     private $decrypted;
 
     /**
      * Create a new Credentials Instance.
-     * @param Encrypter $encrypter
+     *
+     * @param \Illuminate\Contracts\Encryption\Encrypter $encrypter
+     * @return void
      */
     public function __construct(Encrypter $encrypter)
     {
         $this->encrypter = $encrypter;
     }
 
     /**
+     * Load the file.
+     *
      * @param string $filename
      * @return array
      */
     public function load(string $filename)
     {
         if (!file_exists($filename)) {
             $this->decrypted = [];
+
             return $this->decrypted;
         }
 
@@ -48,6 +61,7 @@ public function load(string $filename)
      *
      * @param array $data
      * @param string $filename
+     * @return void
      */
     public function store(array $data, string $filename)
     {
@@ -59,6 +73,8 @@ public function store(array $data, string $filename)
     }
 
     /**
+     * Get an encrypter value.
+     *
      * @param string $key
      * @param null $default
      * @return mixed

src/CredentialsServiceProvider.php

@@ -8,9 +8,10 @@
 
 class CredentialsServiceProvider extends ServiceProvider
 {
-
     /**
      * Bootstrap the application services.
+     *
+     * @return void
      */
     public function boot()
     {
@@ -26,6 +27,11 @@ public function boot()
         }
     }
 
+    /**
+     * Fix the configuration.
+     *
+     * @return void
+     */
     protected function fixConfig()
     {
         collect(array_dot(config()->all()))->filter(function ($item) {
@@ -39,6 +45,8 @@ protected function fixConfig()
 
     /**
      * Register the application services.
+     *
+     * @return void
      */
     public function register()
     {
@@ -52,6 +60,7 @@ public function register()
             }
 
             $encrypter = new Encrypter($key, config('credentials.cipher'));
+
             return new Credentials($encrypter);
         });
 

src/EditCredentialsCommand.php

@@ -5,7 +5,6 @@
 use Illuminate\Console\Command;
 use Symfony\Component\Process\Process;
 use BeyondCode\Credentials\Exceptions\InvalidJSON;
-use Symfony\Component\Process\Exception\ProcessFailedException;
 
 class EditCredentialsCommand extends Command
 {
@@ -23,6 +22,12 @@ class EditCredentialsCommand extends Command
      */
     protected $description = 'Encrypt and edit existing credentials. They will be decrypted after saving.';
 
+    /**
+     * The command handler.
+     *
+     * @param \BeyondCode\Credentials\Credentials $credentials
+     * @return void
+     */
     public function handle(Credentials $credentials)
     {
         $filename = config('credentials.file');
@@ -51,4 +56,4 @@ public function handle(Credentials $credentials)
 
         $this->info('Successfully updated credentials.');
     }
-}
+}

src/Exceptions/InvalidJSON.php

@@ -6,11 +6,23 @@
 
 class InvalidJSON extends Exception
 {
+    /**
+     * Create a new InvalidJson exception instance.
+     *
+     * @param int $error
+     * @return $this
+     */
     public static function create($error)
     {
         return new static("Unable to parse credential JSON ".self::getErrorMessage($error));
     }
 
+    /**
+     * Get the error message.
+     *
+     * @param int $error
+     * @return string
+     */
     private static function getErrorMessage($error)
     {
         switch ($error) {

src/helpers.php

@@ -2,17 +2,25 @@
 
 use BeyondCode\Credentials\Credentials;
 
-if (!function_exists('credentials')) {
-    function credentials(string $key, $default = null) {
+if (! function_exists('credentials')) {
+    /**
+     * Get a an encrypted value.
+     *
+     * @param string $key
+     * @param null $default
+     * @return mixed
+     */
+    function credentials(string $key, $default = null)
+    {
         $filename = config('credentials.file');
 
         try {
-        	$credentials = app(Credentials::class);
-        	$credentials->load($filename);
+            $credentials = app(Credentials::class);
+            $credentials->load($filename);
 
-        	return $credentials->get($key, $default);
+            return $credentials->get($key, $default);
         } catch (ReflectionException $e) {
-			return Credentials::CONFIG_PREFIX.$key;
+            return Credentials::CONFIG_PREFIX.$key;
         }
     }
 }