master - made internal functions private, added scopes in readme

Author: ionghitun

phpunit.xml

@@ -17,7 +17,7 @@
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
+            <directory suffix=".php">./src/Models</directory>
         </whitelist>
     </filter>
     <logging>

readme.md

@@ -46,6 +46,12 @@ You can use Validator on these fields with:
 - exists_encrypted
 
         exists_encrypted:<table>,<field(optional)>
+        
+You cannot use basic where, orWhere, orderBy on encrypted fields so there are 3 predefined scopes that you can use as a replacer:
+
+- whereEncrypted
+- orWhereEncrypted
+- orderByEncrypted
 
 Possibility to anonymize data:
 
@@ -70,3 +76,5 @@ The method accepts a locale parameter, if you want to use faker with localizatio
 If is not specified by any method above, the default Faker local will be used by default
 
 Note: Model is not automatically saved!
+
+_Happy coding!_

src/Models/BaseModel.php

@@ -50,7 +50,7 @@ public function getAttribute($key)
         }
 
         if (in_array($key, $this->encrypted)) {
-            $value = $this->aesDecrypt($value);
+            return $this->aesDecrypt($value);
         }
 
         return $value;
@@ -65,7 +65,7 @@ public function getAttribute($key)
      *
      * @return false|string
      */
-    protected function aesDecrypt($val, $cypher = 'aes-128-ecb', $mySqlKey = true)
+    private function aesDecrypt($val, $cypher = 'aes-128-ecb', $mySqlKey = true)
     {
         $secret = getenv('ENCRYPTION_KEY');
 
@@ -81,13 +81,14 @@ protected function aesDecrypt($val, $cypher = 'aes-128-ecb', $mySqlKey = true)
      *
      * @return string
      */
-    protected function generateMysqlAesKey($key)
+    private function generateMysqlAesKey($key)
     {
         $generatedKey = str_repeat(chr(0), 16);
 
         for ($i = 0, $len = strlen($key); $i < $len; $i++) {
             $generatedKey[$i % 16] = $generatedKey[$i % 16] ^ $key[$i];
         }
+
         return $generatedKey;
     }
 
@@ -117,7 +118,7 @@ public function setAttribute($key, $value)
      *
      * @return false|string
      */
-    protected function aesEncrypt($val, $cypher = 'aes-128-ecb', $mySqlKey = true)
+    private function aesEncrypt($val, $cypher = 'aes-128-ecb', $mySqlKey = true)
     {
         $secret = getenv('ENCRYPTION_KEY');
 
@@ -181,53 +182,67 @@ public function getAnonymizable()
         return $this->anonymizable;
     }
 
+    /**
+     * Anonymize model fields
+     *
+     * @param string|null $locale
+     */
+    public function anonymize($locale = null)
+    {
+        $faker = Factory::create($locale ?? (getenv('FAKER_LOCALE') ?? Factory::DEFAULT_LOCALE));
+
+        foreach ($this->anonymizable as $field => $type) {
+            if (in_array($field, $this->attributes)) {
+                $method = $type[0];
+
+                if (count($type) > 1) {
+                    $this->$field = call_user_func([$faker, $method], array_slice($type, 1));
+                } else {
+                    $this->$field = $faker->$method;
+                }
+            }
+        }
+    }
+
     /**
      * where for encrypted columns
      *
      * @param $query
-     * @param $field
+     * @param $column
      * @param $value
      *
      * @return mixed
      */
-    public function scopeWhereEncrypted($query, $field, $value)
+    public function scopeWhereEncrypted($query, $column, $value)
     {
-        return $query->whereRaw('AES_DECRYPT(' . $field . ', "' . getenv("ENCRYPTION_KEY") . '") LIKE "' . $value . '" COLLATE utf8mb4_general_ci');
+        return $query->whereRaw('AES_DECRYPT(' . $column . ', "' . getenv("ENCRYPTION_KEY") . '") LIKE "' . $value . '" COLLATE utf8mb4_general_ci');
     }
 
     /**
      * orWhere for encrypted columns
      *
      * @param $query
-     * @param $field
+     * @param $column
      * @param $value
      *
      * @return mixed
      */
-    public function scopeOrWhereEncrypted($query, $field, $value)
+    public function scopeOrWhereEncrypted($query, $column, $value)
     {
-        return $query->orWhereRaw('AES_DECRYPT(' . $field . ', "' . getenv("ENCRYPTION_KEY") . '") LIKE "' . $value . '" COLLATE utf8mb4_general_ci');
+        return $query->orWhereRaw('AES_DECRYPT(' . $column . ', "' . getenv("ENCRYPTION_KEY") . '") LIKE "' . $value . '" COLLATE utf8mb4_general_ci');
     }
 
     /**
-     * Anonymize model fields
+     * orderBy for encrypted columns
      *
-     * @param string|null $locale
+     * @param $query
+     * @param $column
+     * @param $direction
+     *
+     * @return mixed
      */
-    public function anonymize($locale = null)
+    public function scopeOrderByEncrypted($query, $column, $direction)
     {
-        $faker = Factory::create($locale ?? (getenv('FAKER_LOCALE') ?? Factory::DEFAULT_LOCALE));
-
-        foreach ($this->anonymizable as $field => $type) {
-            if (in_array($field, $this->attributes)) {
-                $method = $type[0];
-
-                if (count($type) > 1) {
-                    $this->$field = call_user_func([$faker, $method], array_slice($type, 1));
-                } else {
-                    $this->$field = $faker->$method;
-                }
-            }
-        }
+        return $query->orderByRaw('AES_DECRYPT(' . $column . ', "' . getenv("ENCRYPTION_KEY") . '") ' . $direction);
     }
 }