README

English | 中文

A Symfony bundle for managing WeChat Mini Program subscribe messages. This bundle provides comprehensive functionality for handling subscribe message categories, templates, and message sending with an intuitive admin interface.

Features
Installation
Configuration
Quick Start
Advanced Usage
Commands
- wechat:mini-program:sync-subscribe-categories
- wechat-mini-program:sync-subscribe-template
Admin Interface
Security
Contributing
Dependencies
License

Features

Subscribe Categories Management: Automatically sync and manage subscribe message categories from WeChat API
Template Management: Sync and manage subscribe message templates with parameters
Message Sending: Send subscribe messages to users with expression language support
Admin Interface: Complete EasyAdmin CRUD controllers for data management
Cron Job Integration: Automatic synchronization with configurable schedules
Event System: Event-driven architecture for message handling and logging
Expression Language: Dynamic message content with expression language support

Installation

Install the bundle via Composer:

composer require tourze/wechat-mini-program-subscribe-message-bundle

Add the bundle to your config/bundles.php:

<?php
return [
    // ... other bundles
    WechatMiniProgramSubscribeMessageBundle\WechatMiniProgramSubscribeMessageBundle::class => ['all' => true],
];

Configuration

The bundle integrates with the WeChat Mini Program Bundle configuration. Make sure you have configured your WeChat Mini Program account credentials:

# config/packages/wechat_mini_program.yaml
wechat_mini_program:
    accounts:
        default:
            app_id: '%env(WECHAT_MINI_PROGRAM_APP_ID)%'
            secret: '%env(WECHAT_MINI_PROGRAM_SECRET)%'

Optionally, you can configure the bundle's specific settings:

# config/packages/wechat_mini_program_subscribe_message.yaml
wechat_mini_program_subscribe_message:
    # Enable/disable automatic template synchronization
    auto_sync: true
    
    # Default settings for message sending
    default_settings:
        page: 'pages/index'
        miniprogram_state: 'formal'  # formal, trial, developer

Quick Start

Configure your WeChat Mini Program account credentials in your WeChat Mini Program Bundle configuration.
Run the database migration to create required tables:

php bin/console doctrine:migrations:migrate

Sync subscribe categories and templates from WeChat API:

# Sync subscribe message categories
php bin/console wechat:mini-program:sync-subscribe-categories

# Sync subscribe message templates
php bin/console wechat-mini-program:sync-subscribe-template

Send a subscribe message:

use WechatMiniProgramSubscribeMessageBundle\Request\SendSubscribeMessageRequest;
use WechatMiniProgramBundle\Service\Client;

$request = new SendSubscribeMessageRequest();
$request->setToUser('user_openid');
$request->setTemplateId('your_template_id');
$request->setPage('pages/index');
$request->setData([
    'thing1' => ['value' => 'Message content'],
    'time2' => ['value' => '2023-01-01 10:00:00'],
]);

$response = $client->request($request);

Advanced Usage

Expression Language Functions

The bundle provides expression language functions for dynamic message sending:

// In your expression language context
sendWechatMiniProgramSubscribeMessage(user, 'template_id', ['param1' => 'value:context.data'])

Working with Templates

use WechatMiniProgramSubscribeMessageBundle\Repository\SubscribeTemplateRepository;

// Get available templates
$templates = $subscribeTemplateRepository->findBy(['state' => 1]);

// Access template parameters
foreach ($template->getSubscribeParams() as $param) {
    echo $param->getName() . ': ' . $param->getExample();
}

Event Handling

The bundle dispatches events during message processing:

use WechatMiniProgramSubscribeMessageBundle\Event\SubscribeMsgPopupEvent;

// Listen to subscribe message popup events
class SubscribeMessageListener
{
    public function onSubscribeMsgPopup(SubscribeMsgPopupEvent $event): void
    {
        // Handle the event
    }
}

Commands

`wechat:mini-program:sync-subscribe-categories`

Synchronizes subscribe message categories from WeChat API.

Schedule: Every 2 hours at 11 minutes past the hour
Function: Fetches and updates categories for all valid WeChat accounts

`wechat-mini-program:sync-subscribe-template`

Synchronizes subscribe message templates from WeChat API.

Schedule: Every 4 hours at 15 minutes past the hour
Function: Fetches templates and their parameters

Admin Interface

Access the admin interface through EasyAdmin controllers:

Subscribe Categories: Manage message categories
Subscribe Templates: Manage message templates
Subscribe Parameters: Configure template parameters
Message Logs: View sent message history
Send Logs: Monitor message delivery status

Security

This bundle handles sensitive WeChat API credentials. Ensure:

Keep your WeChat API credentials secure
Use environment variables for sensitive configuration
Regularly rotate API keys
Monitor access to admin interfaces
Validate all user inputs before sending messages

Contributing

We welcome contributions! Please:

Fork the repository
Create a feature branch
Write tests for your changes
Follow PSR-12 coding standards
Submit a pull request

Dependencies

This bundle requires the following main dependencies:

PHP: ^8.1
Symfony: ^6.4
Doctrine ORM: ^3.0
EasyAdmin Bundle: ^4
WeChat Mini Program Bundle: tourze/wechat-mini-program-bundle

See composer.json for the complete list of dependencies.

License

This bundle is licensed under the MIT License. See the LICENSE file for details.

tourze / wechat-mini-program-message-bundle

Maintainers

Details