Activities Plugin - Documentation Quick Reference

Quick Links to Documentation:

• Plugin Architecture & Configuration - START HERE
• Workflows & Authorization Lifecycle - Business logic and workflows
• Refactoring Summary - What changed

Quick Start: Where to Find What

For Understanding the Plugin Architecture

→ Read: 5.6.1-activities-plugin-architecture.md

Covers:

• Plugin design and structure
• All core components and entities
• Service registration and dependency injection
• Navigation and UI integration
• Configuration management

For Understanding Authorization Workflows

→ Read: 5.6-activities-plugin.md

Covers:

• Authorization lifecycle and state machine
• Request/approval/renewal/revocation workflows
• Multi-level approval process
• Activity management
• Integration with RBAC

For Integration in Your Code

→ Read: 5.6.1-activities-plugin-architecture.md § Service Registration

Shows:

• How to inject the AuthorizationManagerInterface
• Controller integration examples
• Service layer usage patterns

For Configuration

→ Read: 5.6.1-activities-plugin-architecture.md § Configuration Management

Explains:

• Application settings
• Configuration versioning
• Automatic migrations
• Default initialization

Key Documentation Updates

Important: Status constants updated from 5 to 6:

• APPROVED_STATUS - Authorization is active and valid
• PENDING_STATUS - Authorization awaiting approval
• DENIED_STATUS - Authorization request was rejected
• REVOKED_STATUS - Previously approved authorization was revoked
• EXPIRED_STATUS - Authorization has passed its expiration date
• RETRACTED_STATUS - Member retracted pending request ← ADDED

Source Code Documentation

The Activities Plugin source file has been refactored for clarity:

• Minimal inline documentation focused on maintenance
• Code docblocks link to comprehensive /docs files
• All usage examples moved to documentation
• All integration patterns documented separately

Documentation Structure

Activities Plugin Documentation

├── Architecture & Configuration (5.6.1)
│   ├── Plugin overview and design
│   ├── Core components
│   ├── Initialization and bootstrap
│   ├── Service registration
│   ├── Navigation & UI integration
│   ├── Configuration management
│   └── Routing & middleware
│
├── Workflows & Lifecycle (5.6)
│   ├── Authorization lifecycle
│   ├── Activity management
│   ├── Request/approval/renewal/revocation
│   ├── Multi-level approval
│   ├── Integration points
│   └── References
│
└── Refactoring Summary
    ├── What changed and why
    ├── Accuracy improvements
    ├── Files modified
    └── Benefits realized

Common Tasks

“I need to add an authorization request to my controller”

1. Read: Service Registration § Usage in Controllers
2. Get the service: AuthorizationManagerInterface $authorizationManager
3. Call: $authorizationManager->request($activityId, $memberId)

“I need to understand the full authorization lifecycle”

1. Read: Authorization Lifecycle Workflow
2. Review: State machine diagram showing all transitions
3. Check: Status constants and their meanings

“I need to know what authorizations a member has”

1. Read: Member Participation Tracking
2. Review: Authorization entity relationships
3. Check: Available queries and finder methods

“I need to configure how many approvers are needed”

1. Read: Activity Entity
2. Set: num_required_authorizors for new requests
3. Set: num_required_renewers for renewals

“I need to add navigation items for Activities”

1. Read: Navigation & UI Integration
2. Review: Dynamic navigation provider pattern
3. Check: Permission-based visibility implementation

Related Documentation

• RBAC Security Architecture - Permission system
• Member Lifecycle - Member management
• Branch Hierarchy - Organizational structure

Questions?

Refer to the comprehensive documentation files or review the plugin source code:

• app/plugins/Activities/src/ActivitiesPlugin.php - Plugin initialization
• app/plugins/Activities/src/Services/ - Service layer implementation
• app/plugins/Activities/src/Model/ - Entity definitions