Merge pull request #13 from Syrian-Open-Source/v1.2.0

V1.2.0

Author: karam-mustafa

.github/workflows/php.yml

@@ -2,9 +2,9 @@ name: PHP Composer
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main,v1.2.0 ]
   pull_request:
-    branches: [ main ]
+    branches: [ main,v1.2.0 ]
 
 jobs:
   build:

.php-cs-fixer.cache

@@ -1 +1 @@
-{"php":"8.1.3","version":"3.7.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Abstracts\/RelationalRelationAbstract.php":3299928560,"src\/Classes\/RelationalMetrics.php":842680276,"src\/Interfaces\/RelationalInterface.php":1128215520,"tests\/Unit\/ExampleTest.php":3900274864,"tests\/BaseTest.php":3538535820,"tests\/Feature\/ExampleTest.php":3639981892}}
+{"php":"8.1.3","version":"3.7.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Abstracts\/RelationalRelationAbstract.php":2085162138,"src\/Classes\/RelationalMetrics.php":3212978355,"src\/Interfaces\/RelationalInterface.php":1128215520,"tests\/Unit\/ExampleTest.php":3900274864,"tests\/BaseTest.php":3538535820,"tests\/Feature\/ExampleTest.php":3639981892,"src\/Facades\/RelationalMetricsFacade.php":775496722,"src\/Providers\/RelationalMetricsServiceProviders.php":969866632}}

README.md

@@ -20,12 +20,15 @@ composer require syrian-open-source/laravel-relational-metrics
 
 Usage
 ---------
+```php
+        // first you must make a model from facade class
+        // like post model 
+        $instance = \SOS\RelationalMetrics\Facades\RelationalMetricsFacade::setModel("Post"); 
+        // or you can specify thr model name by this way:  RelationalMetricsFacade::setModel(Store::class); 
+```
 The Basic Usage of this package is the same of getting count of some model instances, but with a styled response 
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
-        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
-        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         $metrics = $instance->getBasicMetrics();
         // or you can get the count or the message directly.
         $directCount = $instance->getCount(); 
@@ -45,9 +48,6 @@ What you can do next, you could get the metrics of a model depending on one of i
 Let's assume we want to get the number of stores that has products with price more than 500
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
-        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
-        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         $metrics = $instance->getRelationalMetrics($relationName, $relationColumn, $value);
         // example: $instance->getRelationalMetrics('products, 'price', 500);
         /*
@@ -66,9 +66,6 @@ And last but not least, You could get the metrics about a model depending on any
 
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
-        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
-        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         // example for the conditions
         $conditions = [
                   ['method' => 'where', 'column' => 'address', 'operator' => 'like', 'value' => '%UAE%'],

composer.json

@@ -33,6 +33,13 @@
             "SOS\\RelationalMetrics\\Tests\\": "src/tests"
         }
     },
+    "extra" : {
+        "laravel" : {
+            "providers" : [
+                "SOS\\RelationalMetrics\\Providers\\RelationalMetricsServiceProviders"
+            ]
+        }
+    },
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-coverage": "phpunit --coverage-html coverage",