frictionlessdata / datapackage-php

src/Validators/BaseValidator.php

Doc Comments +7 added lines, -1 removed lines

@@ -9,6 +9,9 @@ 
 
 abstract class BaseValidator extends SchemaValidator
 {
+    /**
+     * @param string $basePath
+     */
     public function __construct($descriptor, $basePath = null)
     {
         $this->basePath = $basePath;
@@ -122,6 +125,9 @@ 
         $this->validateSchemaUrl($this->getValidationSchemaUrl());
     }
 
+    /**
+     * @param string $url
+     */
     protected function validateSchemaUrl($url)
     {
         $validator = new \JsonSchema\Validator();
@@ -141,7 +147,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/Validators/DatapackageValidator.php

Doc Comments +3 added lines

@@ -70,6 +70,9 @@
         return ResourceValidator::validate($resourceDescriptor, $this->basePath);
     }
 
+    /**
+     * @param string $profile
+     */
     protected function getJsonSchemaFileFromRegistry($profile)
     {
         if ($filename = Registry::getJsonSchemaFile($profile)) {

src/Factory.php

Doc Comments +16 added lines, -1 removed lines

@@ -229,6 +229,8 @@ 
     /**
      * allows extending classes to add custom sources
      * used by unit tests to add a mock http source.
+     * @param string $source
+     * @return string
      */
     protected static function normalizeHttpSource($source)
     {
@@ -238,6 +240,7 @@ 
     /**
      * allows extending classes to add custom sources
      * used by unit tests to add a mock http source.
+     * @param string $source
      */
     protected static function isHttpSource($source)
     {
@@ -251,7 +254,7 @@ 
      *   - normalized basePath.
      *
      * @param $source
-     * @param $basePath
+     * @param null|string $basePath
      *
      * @return object
      *
@@ -321,16 +324,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)
     {
         $tempfile = tempnam(sys_get_temp_dir(), 'datapackage-php');
@@ -342,6 +354,9 @@ 
         return self::loadFileZipSource($tempfile);
     }
 
+    /**
+     * @param string $source
+     */
     protected static function loadFileZipSource($source)
     {
         $zippy = Zippy::load();