Fix documentation that led to Issue #37 (#42)

Author: ipundit

.gitignore

@@ -1,18 +1,21 @@
-.project
-.idea
-.buildpath
-.settings
-*.log
 *.db
+*.log
 *.swp
-.phpunit.cache
-vendor/*
-output/*
-composer.lock
-phpunit.xml
+.buildpath
+.idea
 .php_cs.cache
 .php_cs
-docs/api
+.php-cs-fixer.cache
+.phpunit.cache
 .phpunit.result.cache
+.project
+.settings
 .stan-cache
-.php-cs-fixer.cache
+/.vscode
+/docs/api
+/node_modules/*
+/output/*
+/vendor/*
+composer.lock
+package-lock.json
+phpunit.xml

.php-cs-fixer.php

@@ -2,7 +2,16 @@
 
 $finder = new PhpCsFixer\Finder();
 $config = new PhpCsFixer\Config('json-schema', 'json-schema style guide');
-$finder->in(__DIR__ . '/lib');
+$finder->in(__DIR__)
+    ->exclude('.github')
+    ->exclude('.phpunit.cache')
+    ->exclude('.stan.cache')
+    ->exclude('.vscode')
+    ->exclude('assets')
+    ->exclude('docs')
+    ->exclude('node_modules')
+    ->exclude('output')
+    ->exclude('vendor');
 
 $config
     ->setRules([

.travis.yml

@@ -1671,7 +1671,7 @@ public static function last(/* ... */)
      * YourModel::find(1,2,3);
      *
      * # finding by pk accepts an options array
-     * YourModel::find(123,array('order' => 'name desc'));
+     * YourModel::find(123, ['order' => 'name desc']);
      * ```
      *
      * Finding by using a conditions array:
@@ -1719,19 +1719,19 @@ public static function last(/* ... */)
      * 	array<string, int|string>					static				User::find(["name"=>"Philip"]);
      * 	"first"										static|null			User::find("first", ["name"=>"Waldo"]);
      * 	"last"										static|null			User::find("last", ["name"=>"William"]);
-     *  "all"										static[]			User::find("all", ["name" => "Stephen"]
+     *  "all"										static[]			User::find("all", ["name"=>"Stephen"]
      *  ...int|string								static[]			User::find(1, 3, 5, 8);
      *  array<int,int|string>						static[]			User::find([1,3,5,8]);
-     * 	array<"conditions", array<string,string>>	static[]			User::find(["conditions"=> ["name" => "Kurt"]]);
+     * 	array<"conditions", array<string, string>>	static[]			User::find(["conditions"=>["name"=>"Kurt"]]);
      */
-    public static function find(/* $type, $options */)
+    public static function find(/* $type, $options */): static|array|null
     {
         $class = get_called_class();
 
-        if (func_num_args() <= 0) {
+        $args = func_get_args();
+        if (0 === count($args)) {
             throw new RecordNotFound("Couldn't find $class without an ID");
         }
-        $args = func_get_args();
         $options = static::extract_and_validate_options($args);
 
         $num_args = count($args);
@@ -1765,7 +1765,7 @@ public static function find(/* $type, $options */)
 
         // find by pk
         else {
-            if (1 === count($args) && 1 == $num_args) {
+            if (1 === $num_args) {
                 $args = $args[0];
             }
 

lib/Model.php

@@ -24,18 +24,18 @@ public function tearDown(): void
         Cache::initialize();
     }
 
-    public function test_default_expire()
+    public function testDefaultExpire()
     {
         $this->assertEquals(30, Cache::$options['expire']);
     }
 
-    public function test_explicit_default_expire()
+    public function testExplicitDefaultExpire()
     {
         Config::instance()->set_cache('memcache://localhost', ['expire' => 1]);
         $this->assertEquals(1, Cache::$options['expire']);
     }
 
-    public function test_caches_column_meta_data()
+    public function testCachesColumnMetaData()
     {
         Author::first();