Merge branch '4.9' into 5.0.0

# Conflicts:
#	.github/workflows/phpunit.yml
#	README.md
#	composer.json

Author: byjg

.github/workflows/phpunit.yml

@@ -22,16 +22,16 @@ jobs:
           - "7.4"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: composer install
       - run: ./vendor/bin/phpunit --stderr
 
   Documentation:
-    runs-on: 'ubuntu-latest'
-    needs: Build
     if: github.ref == 'refs/heads/master'
-    env:
-      DOC_GITHUB_TOKEN: '${{ secrets.DOC_TOKEN }}'
-    steps:
-      - uses: actions/checkout@v3
-      - run: curl https://opensource.byjg.com/add-doc.sh | bash /dev/stdin php authuser
+    needs: Build
+    uses: byjg/byjg.github.io/.github/workflows/add-doc.yaml@master
+    with:
+      folder: php
+      project: ${{ github.event.repository.name }}
+    secrets: inherit
+

.vscode/launch.json

@@ -1,10 +1,10 @@
 # Auth User PHP
 
-[![Build Status](https://github.com/byjg/authuser/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/authuser/actions/workflows/phpunit.yml)
+[![Build Status](https://github.com/byjg/php-authuser/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/php-authuser/actions/workflows/phpunit.yml)
 [![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
-[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/authuser/)
-[![GitHub license](https://img.shields.io/github/license/byjg/authuser.svg)](https://opensource.byjg.com/opensource/licensing.html)
-[![GitHub release](https://img.shields.io/github/release/byjg/authuser.svg)](https://github.com/byjg/authuser/releases/)
+[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/php-authuser/)
+[![GitHub license](https://img.shields.io/github/license/byjg/php-authuser.svg)](https://opensource.byjg.com/opensource/licensing.html)
+[![GitHub release](https://img.shields.io/github/release/byjg/php-authuser.svg)](https://github.com/byjg/php-authuser/releases/)
 
 A simple and customizable class for enable user authentication inside your application. It is available on XML files, Relational Databases and Moodle.
 
@@ -316,16 +316,26 @@ $users = new ByJG\Authenticate\UsersDBDataset(
 Just type:
 
 ```bash
-composer require "byjg/authuser=5.0.*"
+composer require "byjg/authuser"
 ```
 
 ## Running Tests
 
 Because this project uses PHP Session you need to run the unit test the following manner:
 
 ```bash
-phpunit --stderr
+./vendor/bin/phpunit --stderr
 ```
 
+## Dependencies
+
+```mermaid  
+flowchart TD  
+    byjg/authuser --> byjg/micro-orm
+    byjg/authuser --> byjg/cache-engine
+    byjg/authuser --> byjg/jwt-wrapper  
+```
+
+
 ----
 [Open source ByJG](http://opensource.byjg.com)

README.md

@@ -10,9 +10,9 @@
   "prefer-stable": true,
   "require": {
     "php": ">=7.4",
-    "byjg/micro-orm": "5.0.0.x-dev",
-    "byjg/cache-engine": "5.0.0.x-dev",
-    "byjg/jwt-wrapper": "5.0.0.x-dev"
+    "byjg/micro-orm": "4.9.*",
+    "byjg/cache-engine": "4.9.*",
+    "byjg/jwt-wrapper": "4.9.*"
   },
   "require-dev": {
     "phpunit/phpunit": "5.7.*|7.4.*|^9.5"

composer.json

@@ -49,7 +49,7 @@ public function getUser($filter);
     /**
      * Enter description here...
      *
-     * @param int $userid
+     * @param int|string $userid
      * @return Row
      */
     public function getById($userid);
@@ -99,7 +99,7 @@ public function isAdmin($userId);
 
     /**
      * @desc Check if the user have rights to edit specific site.
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      * @return True if have rights; false, otherwisebool
@@ -108,23 +108,31 @@ public function hasProperty($userId, $propertyName, $value = null);
 
     /**
      * @desc Return all sites from a specific user
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @return string[] String vector with all sites
      */
     public function getProperty($userId, $propertyName);
 
     /**
      *
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      */
     public function addProperty($userId, $propertyName, $value);
 
     /**
      *
-     * @param int $userId
+     * @param int|string $userId
+     * @param string $propertyName
+     * @param string $value
+     */
+    public function setProperty($userId, $propertyName, $value);
+
+    /**
+     *
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      */

src/Interfaces/UsersInterface.php

@@ -162,7 +162,7 @@ public function getUsersByPropertySet($propertiesArray)
     }
 
     /**
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      * @return boolean
@@ -187,8 +187,19 @@ public function addProperty($userId, $propertyName, $value)
         return false;
     }
 
+    public function setProperty($userId, $propertyName, $value)
+    {
+        $user = $this->getById($userId);
+        if ($user !== null) {
+            $user->set($propertyName, $value);
+            $this->save($user);
+            return true;
+        }
+        return false;
+    }
+
     /**
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      * @return boolean

src/UsersAnyDataset.php

@@ -226,7 +226,16 @@ public function hasProperty($userId, $propertyName, $value = null)
         }
 
         $values = $user->get($propertyName);
-        return ($values !== null ? in_array($value, (array)$values) : false);
+
+        if ($values === null) {
+            return false;
+        }
+
+        if ($value === null) {
+            return true;
+        }
+
+        return in_array($value, (array)$values);
     }
 
     /**
@@ -261,7 +270,7 @@ abstract public function getUsersByPropertySet($propertiesArray);
 
     /**
      *
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      */
@@ -271,7 +280,7 @@ abstract public function addProperty($userId, $propertyName, $value);
      * Remove a specific site from user
      * Return True or false
      *
-     * @param int $userId User login
+     * @param int|string $userId User login
      * @param string $propertyName Property name
      * @param string $value Property value with a site
      * @return bool

src/UsersBase.php

@@ -249,6 +249,7 @@ public function getUsersByProperty($propertyName, $value)
     public function getUsersByPropertySet($propertiesArray)
     {
         $query = Query::getInstance()
+            ->field("u.*")
             ->table($this->getUserDefinition()->table(),  "u");
 
         $count = 0;
@@ -263,7 +264,7 @@ public function getUsersByPropertySet($propertiesArray)
     }
 
     /**
-     * @param int $userId
+     * @param int|string $userId
      * @param string $propertyName
      * @param string $value
      * @return bool
@@ -289,11 +290,30 @@ public function addProperty($userId, $propertyName, $value)
         return true;
     }
 
+    public function setProperty($userId, $propertyName, $value)
+    {
+        $query = Query::getInstance()
+            ->table($this->getUserPropertiesDefinition()->table())
+            ->where("{$this->getUserPropertiesDefinition()->getUserid()} = :id", ["id" => $userId])
+            ->where("{$this->getUserPropertiesDefinition()->getName()} = :name", ["name" => $propertyName]);
+
+        $userProperty = $this->propertiesRepository->getByQuery($query);
+        if (empty($userProperty)) {
+            $userProperty = new UserPropertiesModel($propertyName, $value);
+            $userProperty->setUserid($userId);
+        } else {
+            $userProperty = $userProperty[0];
+            $userProperty->setValue($value);
+        }
+
+        $this->propertiesRepository->save($userProperty);
+    }
+
     /**
      * Remove a specific site from user
      * Return True or false
      *
-     * @param int $userId User Id
+     * @param int|string $userId User Id
      * @param string $propertyName Property name
      * @param string $value Property value with a site
      * @return bool

src/UsersDBDataset.php

@@ -181,7 +181,7 @@ public function removeByLoginField($login)
     /**
      * Remove the user based on his user id.
      *
-     * @param int $userId
+     * @param int|string $userId
      * @return void
      * @throws \ByJG\Authenticate\Exception\NotImplementedException
      */

src/UsersMoodleDataset.php

@@ -343,4 +343,13 @@ public function testGetByUserProperty()
         $this->assertEquals($this->prefix . '2', $user[0]->getUserid());
 
     }
+
+    public function testSetProperty()
+    {
+        $this->assertFalse($this->object->hasProperty($this->prefix . '1', 'propertySet'));
+        $this->object->setProperty($this->prefix . '1', 'propertySet', 'somevalue');
+        $this->assertTrue($this->object->hasProperty($this->prefix . '1', 'propertySet'));
+        $this->assertTrue($this->object->hasProperty($this->prefix . '1', 'propertySet', 'somevalue'));
+        $this->assertEquals('somevalue', $this->object->getProperty($this->prefix . '1', 'propertySet'));
+    }
 }