From 74763fb47cf836538728606a94d31667957a6fc2 Mon Sep 17 00:00:00 2001 From: James ZHANG Date: Mon, 15 Jun 2015 17:44:27 +0800 Subject: [PATCH] configuration_initiation.md --- configuration_initiation.md | 175 ++++++++++++++++++++++++++++++++++++ 1 file changed, 175 insertions(+) create mode 100644 configuration_initiation.md diff --git a/configuration_initiation.md b/configuration_initiation.md new file mode 100644 index 0000000..8216c90 --- /dev/null +++ b/configuration_initiation.md @@ -0,0 +1,175 @@ +This project contains several APIs, each of them may have a defferent initial functional parameters. + +All of classes had been also provided the `class_alias`, list its below: *tip: while using the alias classes, you may enable the following line onto your project's boot script. + + +```php +Overtrue\Wechat\Alias::register(); +``` + +If you are favorited While using the `class_alias`, it won't need import the namespace again. + +### Server + + - class: `Overtrue\Wechat\Server` + - alias: `WechatServer` + - parameters: `__construct($appId, $token, $encodingAESKey = null)` + +### Message + + - class: `Overtrue\Wechat\Message` + - alias: `WechatMessage` + - parameters: none + +### User + + - class: `Overtrue\Wechat\User` + - alias: `WechatUser` + - parameters: `__construct($appId, $appSecret)` + +### Group + + - class: `Overtrue\Wechat\Group` + - alias: `WechatGroup` + - parameters: `__construct($appId, $appSecret)` + +### Web Auth + + - class: `Overtrue\Wechat\Auth` + - alias: `WechatAuth` + - parameters: `__construct($appId, $appSecret)` + +### Menu + + - class: `Overtrue\Wechat\Menu` + - alias: `WechatMenu` + - parameters: `__construct($appId, $appSecret)` + +### Menu Items + + - class: `Overtrue\Wechat\MenuItem` + - alias: `WechatMenuItem` + - parameters: `__construct($appId, $appSecret)` + +### JSSDK + + - class: `Overtrue\Wechat\Js` + - alias: `WechatJs` + - parameters: `__construct($appId, $appSecret)` + +### Customer Service(aka: Hotline) + + - class: `Overtrue\Wechat\Staff` + - alias: `WechatStaff` + - parameters: `__construct($appId, $appSecret)` + +### Store + + - class: `Overtrue\Wechat\Store` + - alias: `WechatStore` + - parameters: `__construct($appId, $appSecret)` + +### WeChat Card + + - class: `Overtrue\Wechat\Card` + - alias: `WechatCard` + - parameters: `__construct($appId, $appSecret)` + +### QR Code + + - class: `Overtrue\Wechat\QRCode` + - alias: `WechatQRCode` + - parameters: `__construct($appId, $appSecret)` + +### Short URL Service + + - class: `Overtrue\Wechat\Url` + - alias: `WechatUrl` + - parameters: `__construct($appId, $appSecret)` + +### Multimedia resources Management + + - class: `Overtrue\Wechat\Media` + - alias: `WechatMedia` + - parameters: `__construct($appId, $appSecret)` + +### Image + + - class: `Overtrue\Wechat\Image` + - alias: `WechatImage` + - parameters: `__construct($appId, $appSecret)` + +### Exception + + - class: `Overtrue\Wechat\Exception` + - alias: `WechatException` + - parameters: `__construct($appId, $appSecret)` + +### BaseMessage + + - class: `Overtrue\Wechat\BaseMessage` + - alias: `WechatBaseMessage` + - parameters: `__construct($appId, $appSecret)` + +### Message:Text + + - class: `Overtrue\Wechat\Messages\Text` + - alias: `WechatTextMessage` + - parameters: None + +### Message:Image + + - class: `Overtrue\Wechat\Messages\Image` + - alias: `WechatImageMessage` + - parameters: None + +### Message:Audio + + - class: `Overtrue\Wechat\Messages\Voice` + - alias: `WechatVoiceMessage` + - parameters: None + +### Message:Video + + - class: `Overtrue\Wechat\Messages\Video` + - alias: `WechatVideoMessage` + - parameters: None + +### Message:News + + - class: `Overtrue\Wechat\Messages\News` + - alias: `WechatNewsMessage` + - parameters: None + +### Message:NewsItem + + - class: `Overtrue\Wechat\Messages\NewsItem` + - alias: `WechatNewsMessageItem` + - parameters: None + +### Message:Location + + - class: `Overtrue\Wechat\Messages\Location` + - alias: `WechatLocationMessage` + - parameters: None + +### Message:Music + + - class: `Overtrue\Wechat\Messages\Music` + - alias: `WechatMusicMessage` + - parameters: None + +### Message:Link + + - class: `Overtrue\Wechat\Messages\Link` + - alias: `WechatLinkMessage` + - parameters: None + +### Message:Transfer(Mandatary for the Hotline Service) + + - class: `Overtrue\Wechat\Messages\Transfer` + - alias: `WechatTransferMessage` + - parameters: None + + +About the PHP namespace, @see [PHP Offical](http://php.net/manual/en/language.namespaces.php) \ No newline at end of file