First Version Fixes

Author: MaherSaleem

README.md

@@ -14,21 +14,25 @@
 * [Special Thanks](#special-thanks)
 * [license](#license)
 
-This package allows you to manage manage counters in the system.
+In some cases, you need to manage the state of the counters in your laravel project, like the number of visitors of your website,
+or number of view for a post, or number of downloads for a file, this needs to create a new table to save these records,
+or at least adding new column for your tables to save the count value.
+
+This package allows you to manage counters in your laravel project.
 
 Once installed you can do stuff like this:
 
 ```php
 
-//increment/decrement system counter
+//increment/decrement system counters
 Counters::increment('number_of_visitors'); 
 
 // increment/decrement model objects counters
 $post->increment('number_of_views');
 $feature->decrement('number_of_bugs');
 $user->decrement('balance', 2); // decrement the balance of the user by 2
 ```
-
+There are many other methods that are mentioned below.
 
 ## Installation
 
@@ -73,8 +77,8 @@ php artisan vendor:publish --provider="Maher\Counters\CountersServiceProvider" -
 
 ## Usage
 ### 1) Using Counters with no models
-First, add the `Maher\Counters\Traits\HasCounter` trait to your `Post` model(s):
-
+First, add the `Maher\Counters\Traits\HasCounter` trait to your  model(s):
+for example we can add it to Post Model
 ```php
 use Maher\Counters\Traits\HasCounter;
 
@@ -132,11 +136,13 @@ $post->removeCounter($key);
 
 //increment the counter with the given $key
 //Note that this will create record in countrable table,if it's not exist
-$post->incrementCounter($key);
+//if $step is entered, it will increment with the value of $step
+$post->incrementCounter($key, $step = null);
 
 //decrement the counter with the given $key
 //Note that this will create record in countrable table,if it's not exist
-$post->decrementCounter($key);
+//if $step is entered, it will decrement with the value of $step
+$post->decrementCounter($key, $step = null);
 
  // will reset the counter value (to initial_value) for the post object.
 $post->resetCounter($key);
@@ -146,7 +152,7 @@ $post->resetCounter($key);
 ### 2) Using Counters with no models.
 Sometimes, you have general counters that are not associated with any models, for example the number visitor for your website.
 
-Therefore, this package will allow you to deat with Counter with these types.
+Therefore, this package will allow you to deal with Counter with these types.
 
 ```php
 
@@ -155,6 +161,8 @@ class Test
 {
     public function incrementFunction()
     {
+        //moreover you can add this function in your public page to be incremented 
+        //every time user hits your website
         Counters::increment('number_of_visitors');
     }
 }
@@ -176,16 +184,16 @@ Counters::setValue($key, $value);
 Counters::setStep($key, $step);
 
 //increment the counter with the given $key
-Counters::increment($key);
+Counters::increment($key, $step = null);
 
 //decrement the counter with the given $key
-Counters::decrement($key);
+Counters::decrement($key, $step = null);
 
  // will reset the counter for the inital_value
 Counters::reset($key);
 ```
 
-In some cases, you want to increment the counter once for every person, for example no need to increment the number_of_visitors counter everytime the same user refreshes the page.
+In some cases, you want to increment the counter once for every person, for example no need to increment the number_of_visitors counter every time the same user refreshes the page.
 
 So you can use these functions:
 

src/Classes/Counters.php

@@ -34,25 +34,28 @@ public function __construct()
      * @param int $step
      * Creating a record in counters table with $key, $name, $inital_value, $step
      */
-    public function create($key, $name, $initial_value = 0, $step = 1){
+    public function create($key, $name, $initial_value = 0, $step = 1)
+    {
         $value = $initial_value;
-        try{
+        try {
             Counter::query()->create(
                 compact('key', 'name', 'initial_value', 'step', 'value')
             );
-        }catch (\Exception $e){
+        } catch (\Exception $e) {
             throw CounterAlreadyExists::create($key);
         }
 
     }
+
     /**
      * @param $key
      * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model|Counter
      * Get a counter object for the given $key
      */
-    public function get($key){
+    public function get($key)
+    {
         $counter = Counter::query()->where('key', $key)->first();
-        if(is_null($counter)){
+        if (is_null($counter)) {
             throw CounterDoesNotExist::create($key);
         }
         return $counter;
@@ -65,7 +68,8 @@ public function get($key){
      * get the counter value for the given $key,
      * $default will be returned in case the key is not found
      */
-    public function getValue($key, $default = null){
+    public function getValue($key, $default = null)
+    {
         $counter = Counter::query()->where('key', $key)->first();
         if ($counter) {
             return $counter->value;
@@ -81,7 +85,8 @@ public function getValue($key, $default = null){
      * @param $value
      * set the value of the given counter's key
      */
-    public function setValue($key, $value){
+    public function setValue($key, $value)
+    {
         Counter::query()->where('key', $key)->update(['value' => $value]);
     }
 
@@ -90,7 +95,8 @@ public function setValue($key, $value){
      * @param $step
      * set the step value for a given counter's
      */
-    public function setStep($key, $step){
+    public function setStep($key, $step)
+    {
         Counter::query()->where('key', $key)->update(['step' => $step]);
 
     }
@@ -101,11 +107,12 @@ public function setStep($key, $step){
      * @return \Illuminate\Database\Eloquent\Model|Counters|null
      * increment the counter with the step
      */
-    public function increment($key){
+    public function increment($key, $step = null)
+    {
 
         $counter = $this->get($key);
-        if($counter){
-            $counter->update(['value' => $counter->value + $counter->step]);
+        if ($counter) {
+            $counter->update(['value' => $counter->value + ($step ?? $counter->step)]);
         }
         return $counter;
     }
@@ -115,11 +122,12 @@ public function increment($key){
      * @return \Illuminate\Database\Eloquent\Model|Counters|null
      * decrement the counter with the step
      */
-    public function decrement($key){
+    public function decrement($key, $step = null)
+    {
 
         $counter = $this->get($key);
-        if($counter){
-            $counter->update(['value' => $counter->value - $counter->step]);
+        if ($counter) {
+            $counter->update(['value' => $counter->value - ($step ?? $counter->step)]);
         }
         return $counter;
     }
@@ -128,10 +136,11 @@ public function decrement($key){
      * @param $key
      * @return \Illuminate\Database\Eloquent\Model|Counters|null
      */
-    public function reset($key){
+    public function reset($key)
+    {
 
         $counter = $this->get($key);
-        if($counter){
+        if ($counter) {
             $counter->update(['value' => $counter->initial_value]);
         }
         return $counter;
@@ -142,10 +151,11 @@ public function reset($key){
      * This function will store a cookie for the counter key
      * If the cookie already exist, the counter will not incremented again
      */
-    public function incrementIfNotHasCookies($key){
+    public function incrementIfNotHasCookies($key, $step = null)
+    {
         $cookieName = $this->getCookieName($key);
-        if(!array_key_exists($cookieName, $_COOKIE)){
-            $this->increment($key);
+        if (!array_key_exists($cookieName, $_COOKIE)) {
+            $this->increment($key, $step);
             setcookie($cookieName, 1);
         }
     }
@@ -155,38 +165,47 @@ public function incrementIfNotHasCookies($key){
      * This function will store a cookie for the counter key
      * If the cookie already exist, the counter will not decremented again
      */
-    public function decrementIfNotHasCookies($key){
+    public function decrementIfNotHasCookies($key, $step = null)
+    {
         $cookieName = $this->getCookieName($key);
-        if(!array_key_exists($cookieName, $_COOKIE)){
-            $this->increment($key);
+        if (!array_key_exists($cookieName, $_COOKIE)) {
+            $this->decrement($key, $step);
             setcookie($cookieName, 1);
         }
     }
 
-
-    /**
-     * @param $key
-     * @return string
-     */
-    private function getCookieName($key){
-        return 'counters-cookie-' . $key;
-    }
-
     /**
      * @param $key
      * @return \Illuminate\Contracts\Routing\UrlGenerator|string
      * Will return the Api url to increment the counter
      */
-    public function getIncrementUrl($key){
-        return url("$this->baseUrl/increment/" . $key);
+    public function getIncrementUrl($key, $step = null)
+    {
+        $url = url("$this->baseUrl/increment/" . $key);
+        if(!is_null($step)){
+            $url .= "?step=$step";
+        }
+        return $url;
     }
 
     /**
      * @param $key
      * @return \Illuminate\Contracts\Routing\UrlGenerator|string
      * Will return the Api url to decrement the counter
      */
-    public function getDecrementUrl($key){
-        return url("$this->baseUrl/decrement/" . $key);
+    public function getDecrementUrl($key, $step = null)
+    {
+        $url = url("$this->baseUrl/decrement/" . $key);
+        if(!is_null($step)){
+            $url .= "?step=$step";
+        }
+        return $url;    }
+    /**
+     * @param $key
+     * @return string
+     */
+    private function getCookieName($key)
+    {
+        return 'counters-cookie-' . $key;
     }
-}
+}

src/Facades/Counters.php

@@ -9,17 +9,25 @@
 /**
  * Class Counters
  * @package Maher\Counters\Facades
- * @method static get($key){
+ * @method static create($key, $name, $initial_value = 0, $step = 1)
+ * @method static get($key)
  * @method static getValue($key, $default = null)
  * @method static setValue($key, $value)
  * @method static setStep($key, $step)
- * @method static increment($key)
- * @method static decrement($key)
- * @method static incrementIfNotHasCookies($key)
- * @method static decrementIfNotHasCookies($key)
+ * @method static increment($key, $step = null)
+ * @method static decrement($key, $step = null)
+ * @method static reset($key)
+ * @method static incrementIfNotHasCookies($key, $step = null)
+ * @method static decrementIfNotHasCookies($key, $step = null)
+ * @method static getIncrementUrl($key, $step = null)
+ * @method static getDecrementUrl($key, $step = null)
  */
 class Counters extends Facade
 {
+
+    /**
+     * @return string
+     */
     public static function getFacadeAccessor()
     {
         return \Maher\Counters\Classes\Counters::class;

src/Http/Controllers/CountersController.php

@@ -20,8 +20,9 @@ public function increment(Request $request, $counter_key)
     {
         $counter = Counters::get($counter_key);
 
+        $step = $request->get('step');
         if ($counter) {
-            $counter = Counters::increment($counter->key);
+            $counter = Counters::increment($counter->key, $step);
              return response()->json(['counter' => $counter], 200);
         }else{
             return response()->json(['counterNotFound' => true], 400);
@@ -31,8 +32,10 @@ public function increment(Request $request, $counter_key)
     public function decrement(Request $request, $counter_key)
     {
         $counter = Counters::get($counter_key);
+        $step = $request->get('step');
+
         if ($counter) {
-            $counter = Counters::decrement($counter->key);
+            $counter = Counters::decrement($counter->key, $step);
             return response()->json(['counter' => $counter], 200);
         }else{
             return response()->json(['counterNotFound' => true], 400);
@@ -56,7 +59,7 @@ public function decrementCounterable(Request $request, $counterable_id)
         $counterable = Counterable::query()->find($counterable_id);
         if($counterable){
             $counter = $counterable->counter;
-            $counterable->update(['value' => $counterable->value + $counter->step]);
+            $counterable->update(['value' => $counterable->value - $counter->step]);
             return response()->json(['counterable' => $counterable], 200);
         }else{
             return response()->json(['counter Not Found' => true], 400);