initial: bootstrap from BukidBountyApp base
This commit is contained in:
35
ai-docs/files/LoginController.md
Normal file
35
ai-docs/files/LoginController.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# LoginController.php
|
||||
|
||||
## Purpose
|
||||
Handles user authentication including login, session extension, and logout operations.
|
||||
|
||||
## Key Components
|
||||
- `LoginController` class
|
||||
- `authenticate()` method
|
||||
- `extendcurrentSession()` method
|
||||
|
||||
## Exported Interfaces
|
||||
- `authenticate()` - Authenticate user via JWT
|
||||
- `extendcurrentSession()` - Extend current session lifetime
|
||||
|
||||
## Inputs
|
||||
- `$request` - HTTP request with username/password
|
||||
- Session data for token validation
|
||||
|
||||
## Outputs
|
||||
- Redirect to home page on success
|
||||
- JSON response on failure
|
||||
- Session creation on successful authentication
|
||||
|
||||
## Side Effects
|
||||
- Creates JWT-based session
|
||||
- Sets session cookie
|
||||
|
||||
## Dependencies
|
||||
- `Hypervel\Support\Facades\Auth`
|
||||
- `App\Models\User`
|
||||
|
||||
## Notes
|
||||
- Uses JWT authentication via Hypervel framework
|
||||
- Validates credentials against database
|
||||
- Supports both web and API authentication
|
||||
42
ai-docs/files/UserModifyAdminPageController.md
Normal file
42
ai-docs/files/UserModifyAdminPageController.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# UserModifyAdminPageController.php
|
||||
|
||||
## Purpose
|
||||
Provides admin-level user modification and management capabilities including enabling/disabling users, password resets, role changes, and session management.
|
||||
|
||||
## Key Components
|
||||
- `UserModifyAdminPageController` class
|
||||
- `PageResponses_UserModify` trait
|
||||
|
||||
## Exported Interfaces
|
||||
- `Response_UserDetails()` - Get user details by hash key
|
||||
- `Response_DisableUser()` / `EnableUser()` - Toggle user active status
|
||||
- `Response_DeleteUser()` - Delete user record
|
||||
- `Response_ResetUserPassword()` - Reset user password
|
||||
- `Response_LogoutUser()` - Force logout user session
|
||||
|
||||
## Inputs
|
||||
- `$hashkey` - User hash key identifier
|
||||
- `$details` - Array of user details to update
|
||||
- `$newPassword` - New password string
|
||||
- `$active` - Boolean for active status
|
||||
- `$request` - Hypervel HTTP request object
|
||||
|
||||
## Outputs
|
||||
- JSON responses with success/error data
|
||||
- User detail arrays or error messages
|
||||
|
||||
## Side Effects
|
||||
- Updates user records in database
|
||||
- Invalidates Redis sessions on force logout
|
||||
- Modifies user password hashes
|
||||
|
||||
## Dependencies
|
||||
- `App\Enums\UserActions`
|
||||
- `App\Http\Controllers\Helpers\Permissions\UserPermissions`
|
||||
- `App\Models\User`
|
||||
- `Hypervel\Support\Facades\Auth`, `Hash`, `Redis`, `Cache`
|
||||
|
||||
## Notes
|
||||
- Uses trait pattern for response handlers
|
||||
- Permission checks via `UserPermissions::isActionPermitted()`
|
||||
- Supports hierarchical user relationships (parent/children)
|
||||
40
ai-docs/files/app.md
Normal file
40
ai-docs/files/app.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# app.js
|
||||
|
||||
## Purpose
|
||||
Main Vue application entry point that sets up the SPA (Single Page Application) architecture with global state management and component loading.
|
||||
|
||||
## Key Components
|
||||
- `createApp()` - Vue app instance creation
|
||||
- `Pinia` - State management (replaces Vuex)
|
||||
- `useUserStore()` - User state management
|
||||
- `useAuth()` - Authentication composable
|
||||
|
||||
## Exported Interfaces
|
||||
- `$navigate` - Global navigation helper
|
||||
- `$user` - User store access
|
||||
- `$auth` - Auth composable access
|
||||
- `$modal` - Modal dialog access
|
||||
|
||||
## Inputs
|
||||
- Server-side page data via `dataset.page`
|
||||
- Component imports from `resources/js/Pages/`
|
||||
|
||||
## Outputs
|
||||
- Vue app mounted to `#app` element
|
||||
- Global navigation via `$navigate` helper
|
||||
- Async component loading based on current route
|
||||
|
||||
## Side Effects
|
||||
- Initializes Pinia state management
|
||||
- Fetches current user data on startup
|
||||
- Registers global components (TopHeader, BottomNav)
|
||||
|
||||
## Dependencies
|
||||
- `createApp`, `h`, `defineAsyncComponent` from Vue 3
|
||||
- `Pinia` for state management
|
||||
- Axios for API calls
|
||||
|
||||
## Notes
|
||||
- Uses Pinia instead of Vuex for state management
|
||||
- Async component loading improves performance
|
||||
- Global `$navigate` helper available for programmatic navigation
|
||||
40
ai-docs/files/viewHelperController.md
Normal file
40
ai-docs/files/viewHelperController.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# viewHelperController.php
|
||||
|
||||
## Purpose
|
||||
Central controller for page rendering and Vue component delivery. Handles both server-side rendering with templates and client-side SPA navigation.
|
||||
|
||||
## Key Components
|
||||
- `viewHelperController` class
|
||||
- `servePageFragmentUnified()` method
|
||||
- `getDefaultDataVariables()` method
|
||||
- `getAllViews()` method
|
||||
|
||||
## Exported Interfaces
|
||||
- `servePageFragment()` - Render page without template
|
||||
- `servePageFragmentWithTemplate()` - Render page with layout template
|
||||
- `getDefaultDataVariables()` - Get default view variables
|
||||
- `getAllViews()` - Get all available blade views
|
||||
|
||||
## Inputs
|
||||
- `$page` - Page identifier (route name)
|
||||
- `$data` - Data payload for the page
|
||||
- `$withTemplate` - Boolean to include layout template
|
||||
|
||||
## Outputs
|
||||
- HTML response with embedded navigation script
|
||||
- Base64-encoded HTML for SPA
|
||||
- View variables including currentUser and userModifyAdmin
|
||||
|
||||
## Side Effects
|
||||
- Renders blade templates
|
||||
- Returns base64-encoded HTML for Vue navigation
|
||||
|
||||
## Dependencies
|
||||
- `App\Enums\UserTypes`
|
||||
- `Hypervel\Support\Facades\Auth`, `Response`, `File`
|
||||
- `App\Http\Controllers\Pages\Core\ApplicationController`
|
||||
|
||||
## Notes
|
||||
- Supports public and authenticated routes
|
||||
- Uses viewMap config for page-to-view mapping
|
||||
- Returns base64-encoded HTML for SPA navigation
|
||||
Reference in New Issue
Block a user