Merge branch 'main' of https://github.com/Obrainwave/access-tree

Author: Obrainwave

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `access-tree` will be documented in this file.

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) access-tree <olaiwolaakeem@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,74 +1,81 @@
-# :package_description
+# This package is to all access and permission rights in any laravel project
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-<!--delete-->
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
+This package is to all access and permission rights in any laravel project
 
-1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
-3. Have fun creating your package.
-4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-<!--/delete-->
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require obrainwave/access-tree
 ```
 
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
+php artisan vendor:publish --tag=":access-tree-migrations"
 php artisan migrate
 ```
 
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-config"
+php artisan vendor:publish --tag="access-tree-config"
 ```
 
-This is the contents of the published config file:
+## Usage
 
+Create a Permission
 ```php
-return [
-];
+$data = [
+     'name' => 'Add User',
+     'status' => 1 or 0
+   ];
+$create = createAccess($data, 'permission');
+echo $create;
 ```
 
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag=":package_slug-views"
+Update a Permission
+```php
+$data = [
+     'data_id' => permission id from Obrainwave\AccessTree\Models\Permission // 3,
+     'name' => 'Add User',
+     'status' => 1 or 0
+   ];
+$update = updateAccess($data, 'permission');
+echo $update;
 ```
 
-## Usage
-
+Create Roles
 ```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
+$data = [
+     'name' => 'Admin',
+     'status' => 1 or 0
+   ];
+$permission_ids = array of permission ids from Obrainwave\AccessTree\Models\Permission // array(1, 5, 4);
+$create = createAccess($data, 'role', $permission_ids);
+echo $create;
 ```
 
-## Testing
+Update Roles
+```php
+$data = [
+     'data_id' => role id // 5,
+     'name' => 'Admin Staff',
+     'status' => 1 or 0
+   ];
+$permission_ids = array of permission ids from Obrainwave\AccessTree\Models\Permission // array(10, 6, 3);
+$update = updateAccess($data, 'role', $permission_ids);
+echo $update;
+```
 
-```bash
-composer test
+Create User Role
+```php 
+$roles = array of roles from Obrainwave\AccessTree\Models\Role // array(2, 5);
+$user_id = id of a user from App\Models\User // 1;
+$user_role = createUserRole($roles, $user_id);
+echo $user_role;
 ```
 
 ## Changelog
@@ -85,7 +92,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Olaiwola Akeem Salau](https://github.com/Obrainwave)
 - [All Contributors](../../contributors)
 
 ## License