frictionlessdata / datapackage-php

src/Datapackages/BaseDatapackage.php

Doc Comments +3 added lines

@@ -224,6 +224,9 @@
         return DatapackageValidator::validate($this->descriptor(), $this->basePath);
     }
 
+    /**
+     * @param string $profile
+     */
     protected static function handlesProfile($profile)
     {
         return false;

Indentation +22 added lines, -22 removed lines

@@ -13,16 +13,16 @@ 
 abstract class BaseDatapackage implements \Iterator
 {
 
-  /**
-   * BaseDatapackage constructor.
-   *
-   * @param object $descriptor
-   * @param null|string $basePath
-   *
-   * @param bool $skipValidations
-   *
-   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
-   */
+    /**
+     * BaseDatapackage constructor.
+     *
+     * @param object $descriptor
+     * @param null|string $basePath
+     *
+     * @param bool $skipValidations
+     *
+     * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
+     */
     public function __construct($descriptor, $basePath = null, $skipValidations = false)
     {
         $this->descriptor = $descriptor;
@@ -191,13 +191,13 @@ 
         $this->saveDescriptor($files['datapackage.json']);
         register_shutdown_function(function () use ($base) {Utils::removeDir($base); });
         if ($zip->open($zip_filename, ZipArchive::CREATE | ZipArchive::OVERWRITE) === TRUE) {
-          foreach ($files as $filename => $resource) {
+            foreach ($files as $filename => $resource) {
             $zip->addFile($resource, $filename);
-          }
-          $zip->close();
+            }
+            $zip->close();
         }
         else {
-          throw new DatapackageInvalidSourceException('zip file could not be saved.');
+            throw new DatapackageInvalidSourceException('zip file could not be saved.');
         }
     }
 
@@ -206,14 +206,14 @@ 
     protected $basePath;
     protected $skipValidations = false;
 
-  /**
-   * called by the resources iterator for each iteration.
-   *
-   * @param object $descriptor
-   *
-   * @return \frictionlessdata\datapackage\Resources\BaseResource
-   * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
-   */
+    /**
+     * called by the resources iterator for each iteration.
+     *
+     * @param object $descriptor
+     *
+     * @return \frictionlessdata\datapackage\Resources\BaseResource
+     * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
+     */
     protected function initResource($descriptor)
     {
         return Factory::resource($descriptor, $this->basePath, $this->skipValidations);

Spacing +1 added lines, -1 removed lines

@@ -189,7 +189,7 @@
             ++$ri;
         }
         $this->saveDescriptor($files['datapackage.json']);
-        register_shutdown_function(function () use ($base) {Utils::removeDir($base); });
+        register_shutdown_function(function() use ($base) {Utils::removeDir($base); });
         if ($zip->open($zip_filename, ZipArchive::CREATE | ZipArchive::OVERWRITE) === TRUE) {
           foreach ($files as $filename => $resource) {
             $zip->addFile($resource, $filename);

Braces +1 added lines, -2 removed lines

@@ -195,8 +195,7 @@
             $zip->addFile($resource, $filename);
           }
           $zip->close();
-        }
-        else {
+        } else {
           throw new DatapackageInvalidSourceException('zip file could not be saved.');
         }
     }

src/Factory.php

Doc Comments +16 added lines, -4 removed lines

@@ -228,9 +228,9 @@ 
      * allows extending classes to add custom sources
      * used by unit tests to add a mock http source.
      *
-     * @param $source
+     * @param string $source
      *
-     * @return mixed
+     * @return string
      */
     protected static function normalizeHttpSource($source)
     {
@@ -240,7 +240,7 @@ 
     /**
      * allows extending classes to add custom sources
      * used by unit tests to add a mock http source.
-     * @param $source
+     * @param string $source
      * @return bool
      */
     protected static function isHttpSource($source)
@@ -255,7 +255,7 @@ 
      *   - normalized basePath.
      *
      * @param $source
-     * @param $basePath
+     * @param null|string $basePath
      *
      * @return object
      *
@@ -330,16 +330,25 @@ 
         return (object) ['descriptor' => $descriptor, 'basePath' => $basePath];
     }
 
+    /**
+     * @param string $source
+     */
     protected static function isHttpZipSource($source)
     {
         return strtolower(substr($source, -4)) == '.zip';
     }
 
+    /**
+     * @param string $source
+     */
     protected static function isFileZipSource($source)
     {
         return strtolower(substr($source, -4)) == '.zip';
     }
 
+    /**
+     * @param string $source
+     */
     protected static function loadHttpZipSource($source)
     {
         print_r('calling loadHttpZipSource');
@@ -352,6 +361,9 @@ 
         return self::loadFileZipSource($tempfile);
     }
 
+    /**
+     * @param string $source
+     */
     protected static function loadFileZipSource($source)
     {
         $zip = new ZipArchive();

Spacing +2 added lines, -2 removed lines

@@ -347,7 +347,7 @@ 
         unlink($tempfile);
         $tempfile .= '.zip';
         stream_copy_to_stream(fopen($source, 'r'), fopen($tempfile, 'w'));
-        register_shutdown_function(function () use ($tempfile) {unlink($tempfile); });
+        register_shutdown_function(function() use ($tempfile) {unlink($tempfile); });
 
         return self::loadFileZipSource($tempfile);
     }
@@ -358,7 +358,7 @@ 
         $tempdir = tempnam(sys_get_temp_dir(), 'datapackage-php');
         unlink($tempdir);
         mkdir($tempdir);
-        register_shutdown_function(function () use ($tempdir) {Utils::removeDir($tempdir); });
+        register_shutdown_function(function() use ($tempdir) {Utils::removeDir($tempdir); });
         /* @noinspection PhpUnhandledExceptionInspection File existence is checked afterwards anyway */
         if (($zip->open($source) === TRUE) && ($zip->extractTo($tempdir) === TRUE)) {
             $zip->close();

Braces +1 added lines, -2 removed lines

@@ -362,8 +362,7 @@
         /* @noinspection PhpUnhandledExceptionInspection File existence is checked afterwards anyway */
         if (($zip->open($source) === TRUE) && ($zip->extractTo($tempdir) === TRUE)) {
             $zip->close();
-        }
-        else {
+        } else {
             throw new Exceptions\DatapackageInvalidSourceException('zip file could not be opened from source.');
         }
 

src/Resources/BaseResource.php

Doc Comments +3 added lines

@@ -251,6 +251,9 @@
 
     abstract protected function getInlineDataStream($data);
 
+    /**
+     * @param string $profile
+     */
     protected static function handlesProfile($profile)
     {
         return false;

src/Validators/BaseValidator.php

Doc Comments +7 added lines, -1 removed lines

@@ -44,6 +44,9 @@ 
         return $this->descriptor->profile;
     }
 
+    /**
+     * @param boolean|string $filename
+     */
     protected function convertValidationSchemaFilenameToUrl($filename)
     {
         $filename = realpath($filename);
@@ -124,6 +127,9 @@ 
         $this->validateSchemaUrl($this->getValidationSchemaUrl());
     }
 
+    /**
+     * @param string $url
+     */
     protected function validateSchemaUrl($url)
     {
         $validator = new \JsonSchema\Validator();
@@ -143,7 +149,7 @@ 
      * Add an error to the validator object - errors are aggregated and returned by validate function.
      *
      * @param int        $code
-     * @param null|mixed $extraDetails
+     * @param string $extraDetails
      */
     protected function addError($code, $extraDetails = null)
     {

src/Package.php

Indentation +30 added lines, -30 removed lines

@@ -8,41 +8,41 @@ 
 class Package
 {
 
-  /**
-   * @param $source
-   * @param null $basePath
-   *
-   * @return \frictionlessdata\datapackage\Datapackages\BaseDatapackage
-   * @throws \Exception
-   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageInvalidSourceException
-   */
-  public static function load($source, $basePath = null)
+    /**
+     * @param $source
+     * @param null $basePath
+     *
+     * @return \frictionlessdata\datapackage\Datapackages\BaseDatapackage
+     * @throws \Exception
+     * @throws \frictionlessdata\datapackage\Exceptions\DatapackageInvalidSourceException
+     */
+    public static function load($source, $basePath = null)
     {
         static::isZipPresent();
         return Factory::datapackage($source, $basePath);
     }
 
-  /**
-   * @param $source
-   * @param null $basePath
-   *
-   * @return \frictionlessdata\datapackage\Validators\DatapackageValidationError[]
-   * @throws \Exception
-   */
-  public static function validate($source, $basePath = null)
+    /**
+     * @param $source
+     * @param null $basePath
+     *
+     * @return \frictionlessdata\datapackage\Validators\DatapackageValidationError[]
+     * @throws \Exception
+     */
+    public static function validate($source, $basePath = null)
     {
         static::isZipPresent();
         return Factory::validate($source, $basePath);
     }
 
-  /**
-   * @param null $descriptor
-   * @param null $basePath
-   *
-   * @return mixed
-   * @throws \Exception
-   */
-  public static function create($descriptor = null, $basePath = null)
+    /**
+     * @param null $descriptor
+     * @param null $basePath
+     *
+     * @return mixed
+     * @throws \Exception
+     */
+    public static function create($descriptor = null, $basePath = null)
     {
         static::isZipPresent();
         $descriptor = Utils::objectify($descriptor);
@@ -54,13 +54,13 @@ 
         return new $packageClass($descriptor, $basePath, true);
     }
 
-  /**
-   * @throws \Exception
-   */
-  private static function isZipPresent() {
+    /**
+     * @throws \Exception
+     */
+    private static function isZipPresent() {
         //If ZipArchive is not available throw Exception.
         if (!class_exists('ZipArchive')) {
-          throw new Exception('Error: Your PHP version is not compiled with zip support');
+            throw new Exception('Error: Your PHP version is not compiled with zip support');
         }
     }
 }