This Web App uses Tailwind and Alpine as its choice CSS and JS frameworks. The import for these are included in the layout.blade.php and should automatically load when deploying the site locally.
If styling is absent, try running:
npm install -D tailwindcss
npx tailwindcss initOr see https://tailwindcss.com/docs/installation.
All functionality has been completed and should be intuitive to navigate. A few pointers in case certain functionality can't be found:
- In the
Manage Userssection, expired users are show in grey. The Zone total includes the total number of zones accessible. Full user details can then be further viewed by drilling down in the table. - When editing users (via the edit button in the Users table), Zones and Doors can be added or taken away using the coloured/greyed out zone/door buttons.
- If as a user, no doors and zones are displayed on the dashboard, you may be expired. Please edit your expiry date using an admin user.
- From the dashboard, Door and Zone details can be further viewed by drilling down into the cards (as can Zones from a User card).
- No warning is currently offered for deleting users. If you delete yourself as an admin, you will lose authorisation immediately.
- If a zone is deleted, all its doors will also be deleted.
NB: Additional functionality has been added such that Doors and Zones can also be deleted and editted.
This README.md details the Eloquent Model relationships and functionality included in Peppero Locks. It is best rendered in an IDE which provides links to classes and migrations (contents page links will work in VSCode but not PHPStorm).
All class files are completed and adequately commented, so this document is an optional read.
Screenshots from the php artisan tinker CLI can be seen in the final section of this readme.
The full project repository can also be found on GitHub. Access to the private repository has been granted to RGayaSU.
The ERD digram below shows the pivot tables used for the model along with primary and foreign key constraints.
%%{
init: {
"securityLevel": "loose",
"startOnLoad": true,
"theme": "forest",
"fontFamily": "monospace",
"logLevel": "info",
"er": {
"diagramPadding": 20
}
}
}%%
erDiagram
USERS ||..o{ ZONAL_ACCESS : has
USERS {
int id PK
string fist_name
string last_name
bool admin_flag
}
ZONAL_ACCESS {
int user_id FK
int zone_id FK
}
ZONAL_ACCESS }o--|| ZONES: has
ZONES {
int id PK
string name
}
ZONES ||--o{ DOORS : contains
DOORS {
int id PK
int zone_id FK
string name
}
DOORS ||--o{ DIRECT_ACCESS : has
DIRECT_ACCESS {
int user_id FK
int door_id FK
}
DIRECT_ACCESS }o--|| USERS: has
As the relationship between Users and Doors is a many-to-many relationship (many users could have direct access to the same door), an additional direct_access pivot table is used to store these associations (see create_doors_users_table).
Access to a Door can therefore be provided to a User by adding a record to the direct_access table. This can either be done via Eloquent's attach method, or using the addAccessToDoor method in the User class.
In the UserSeeder, this has been done for User with id 2:
/** Get an active non-admin user and check for explcit door access */
>>> $user = User::query()
->where([
['admin_flag', false],
['expiry_date', '>', '2022-12-01']
])
->first();
=> App\Models\User {#4620
id: 2,
first_name: "Ashlynn",
last_name: "Wintheiser",
admin_flag: 0,
expiry_date: "2023-10-03",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
}
>>> $user->doors;
=> Illuminate\Database\Eloquent\Collection {#4660
all: [
App\Models\Door {#4696
id: 166,
zone_id: 9,
name: "DR-166",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
pivot: Illuminate\Database\Eloquent\Relations\Pivot {#4694
user_id: 2,
door_id: 166,
},
},
...
App\Models\Door {#4715
id: 971,
zone_id: 10,
name: "DR-971",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
pivot: Illuminate\Database\Eloquent\Relations\Pivot {#4615
user_id: 2,
door_id: 971,
},
},
],
}
/** Find doors for a user without explicit access */
>>> User::find(8)->doors;
=> Illuminate\Database\Eloquent\Collection {#4735
all: [],
}
/** Add explicit access and verify */
>>> User::find(8)->addAccessToDoor(Door::first());
=> null
>>> User::find(8)->doors;
=> Illuminate\Database\Eloquent\Collection {#4730
all: [
App\Models\Door {#4729
id: 166,
zone_id: 9,
name: "DR-166",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
pivot: Illuminate\Database\Eloquent\Relations\Pivot {#4746
user_id: 8,
door_id: 166,
},
},
],
}Once again, the relationship between Users and Zones is a many-to-many relationship, so an additional pivot table, zonal_access stores these relations (see create_users_zones_table).
The database has been seeded with 10 zones using the ZoneSeeder class, 1 of which contains no doors (Zone 1) and one of which has no zonal access given to any users (Zone 10).
The Zones class shows the related Doors and Users via doors and users properties respectively:
/** Get a collection of doors assigned to Zone 2 */
>>> Zone::find(2)->doors;
=> Illuminate\Database\Eloquent\Collection {#4718
all: [
App\Models\Door {#4716
id: 176,
zone_id: 2,
name: "DR-176",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
App\Models\Door {#4618
id: 197,
zone_id: 2,
name: "DR-197",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
...
App\Models\Door {#4754
id: 816,
zone_id: 2,
name: "DR-816",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
],
}
/** Identify all users which have access to Zone 9 */
>>> Zone::find(9)->users;
=> Illuminate\Database\Eloquent\Collection {#4718
all: [
App\Models\User {#4736
id: 1,
first_name: "Sabrina",
last_name: "Okuneva",
admin_flag: 1,
expiry_date: "2026-05-11",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
access: Illuminate\Database\Eloquent\Relations\Pivot {#4749
zone_id: 9,
user_id: 1,
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
},
...
App\Models\User {#4759
id: 10,
first_name: "Pamela",
last_name: "Terry",
admin_flag: 0,
expiry_date: "2025-05-29",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
access: Illuminate\Database\Eloquent\Relations\Pivot {#4719
zone_id: 9,
user_id: 10,
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
},
],
}Note that in the DoorSeeder class, Zone 1 is skipped from attaching any doors.
Meanwhile, in the UserSeeder class, Zone 10 is skipped from attaching any users to.
Admin rights can be determined via the isAdmin method in the User class.
Admin users have access to all doors implicitly, which can be shown by supplying any Door to the hasAccessToDoor method (see next section below).
This does not mean that for Admin users, all doors wil be returned by the doors and zoneDoors properties (which will return just the explicitly accessible doors and zonally accessible doors respectively).
/** Check if user with id 5 is an admin */
>>> User::find(5)->isAdmin();
=> true
/** Update user with id 6 to be an admin */
>>> User::query()->where('id', 6)->update(['admin_flag' => true]);
=> 1In the UserSeeder class, User 1 and User 5 are given admin rights.
This method in the User class groups together the three possible kinds of door access to indicate whether a user has access to a supplied Door, through any of:
- Direct access (
direct_accesstable) → verified via thedoorsproperty. - Zone access (
zonal_accesstable) → verified via thezoneDoorsproperty. - Admin rights (
users.admin_flag == true) → checked using theisAdminmethod.
NB: If re-seeding the database, the following Door ids will be invalid.
/** Verify that user 8 has access to to door from excplicit access*/
>>> User::find(8)->hasAccessToDoor(Door::find(166));
=> true
/** Verify that admin user has access via non-zonal access */
>>> User::find(5)->hasAccessToDoor(Door::find(927));
=> true
/** Verify that user has access via zonal access */
>>> User::find(2)->hasAccessToDoor(Door::find(789));
=> true
/** Verify that an expired user doesn't have access to doors */
>>> User::find(3)->isActive();
=> false
>>> User::find(3)->zoneDoors;
=> Illuminate\Support\Collection {#4608
all: [
App\Models\Door {#4639
id: 176,
zone_id: 2,
name: "DR-176",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
...
]
}
>>> User::find(3)->hasAccessToDoor(Door::find(176));
=> falseAll users must include a value for expiry_date, after which point they will not be able to access any doors, regardless of their admin status.
The status of a user can be checked using the isActive method in the User class, and manually expired using the expire method.
/** Manually expire an active user */
>>> User::find(4)->isActive();
=> true
>>> User::find(4)->expire();
=> null
>>> User::find(4)->isActive();
=> falseThe Eloquent HasManyThrough class is not compatible with a many-to-many relationship as we have with Zones and Users.
Therefore, to show the transitive relationships, the zoneDoors property in the User class is a manual implementation which combines the lists of doors that can be accessed by a given user through zone-access.
/** Get the zones which user 7 can access */
>>> User::find(7)->zones;
=> Illuminate\Database\Eloquent\Collection {#5681
all: [
...
App\Models\Zone {#5698
id: 2,
name: "Zone 2",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
access: Illuminate\Database\Eloquent\Relations\Pivot {#5695
user_id: 6,
zone_id: 2,
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
},
...
],
}
/** Get the doors which zone 2 includes */
>>> Zone::find(2)->doors;
=> Illuminate\Database\Eloquent\Collection {#5678
all: [
...
App\Models\Door {#5686
id: 197,
zone_id: 2,
name: "DR-197",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
...
],
}
/** Verify that these doors are included in zoneDoors */
>>> User::find(7)->zoneDoors;
=> Illuminate\Support\Collection {#5714
all: [
...
App\Models\Door {#5741
id: 197,
zone_id: 2,
name: "DR-197",
created_at: "2022-10-16 22:45:30",
updated_at: "2022-10-16 22:45:30",
},
...
],
}The zoneDoors property would be similar to a list of door_ids from the SQL query:
SELECT
a.user_id
,d.zone_id
,d.id AS door_id
,d.name
FROM doors d
INNER JOIN zonal_access a
ON d.zone_id = a.zone_id
WHERE a.user_id = 2
ORDER BY zone_id, door_id;- PHPDocs and other conventions have been taken from IxFD System PHP Conventions.
- Notes on Accessor properties from Laravel.com.
