neticrm-backend

Overview

This skill provides project-specific PHP backend standards for netiCRM/CiviCRM. It bridges the gap between general PHP knowledge and the CiviCRM-specific architecture this project requires.

Key principle: CiviCRM has a rigid class hierarchy (DAO → BAO → Form/Page). Knowing PHP ≠ knowing where and how to implement logic correctly.

Quick Reference

Class-to-File Mapping

CRM_Core_Transaction          → /CRM/Core/Transaction.php
CRM_Contribute_BAO_Contribution → /CRM/Contribute/BAO/Contribution.php
CRM_Contribute_Form_Contribution → /CRM/Contribute/Form/Contribution.php

Layer Responsibilities

| Layer | Location | Responsibility | |-------|----------|---------------| | DAO | /CRM/**/DAO/ | Auto-generated from XML — never edit manually | | BAO | /CRM/**/BAO/ | Business logic — implement here | | Form | /CRM/**/Form/ | Form handling: preProcess() → buildForm() → postProcess() | | API | /api/v3/ | External API endpoints |

Code Style (summary — see php-coding-style.md for full rules)

• Indentation: 2 spaces
• Class names: CamelCase (CRM_Contribute_BAO_Contribution)
• Methods: camelCase (processContribution())
• Properties: _camelCase (underscore prefix)
• Comparisons: === and !==
• Constants: TRUE, FALSE, NULL — uppercase
• Arrays: short syntax [] always
• Braces: opening brace same line; else/elseif/catch on next line after }
• PHP Version: 7.3+ compatible

Development Workflow

1. Identify the correct layer — business logic → BAO, form handling → Form, external access → API
2. Check existing patterns — search for similar implementations before writing new code
3. Review references — consult references/php-patterns.md for detailed patterns
4. Apply security checks — permissions before data access, parameterized queries always
5. Add translations — all user-facing text must use ts()

References

• PHP Patterns: See php-patterns.md — BAO/Form class structure, routing, permissions, translations, common utilities, testing, security
• Hook System: See hook-system.md — form hooks, data hooks (pre/post), CRM_Utils_Hook methods, real module examples
• Database Schema: See database-schema.md — XML schema structure, field types/attributes, naming conventions, index/FK patterns, path lookup; includes GenCode workflow (ask developer for environment-specific command before running)
• PHP Coding Style: See php-coding-style.md — full PSR1/PSR2/PSR12 rules, brace position, constant case, array syntax, operator spacing, php-cs-fixer usage
• API v3 Endpoints: See api-endpoints.md — file structure, function naming, CRUD helpers, spec functions, custom actions, return values
• API v3 Calls: See neticrm-api skill — entity actions, params, return values; PHP 呼叫方式見 php-api.md