nanexcool/cakephp-yo-plugin

CakePHP 的 Yo 插件

安装: 14

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 0

类型:cakephp-plugin

v0.2.1 2014-07-23 19:32 UTC

This package is not auto-updated.

Last update: 2024-09-24 02:21:52 UTC


README

这个 CakePHP 插件提供了一个简单的组件,可以从控制器发送 Yos,以及可以附加到你的模型上的行为。

http://dev.justyo.co/ 获取你的 API 密钥

要求

PHP >= 5.2 且支持 CURL

CakePHP 2 及以上版本

用法

Yo 文件夹复制到你的 app/Plugin 目录。

app/Config/bootstrap.php 中加载插件

CakePlugin::loadAll(); // Loads all plugins at once
CakePlugin::load('Yo'); //Loads a single plugin

Yo/Config/config.php 中输入你的 API 密钥

Configure::write('Yo.apiKey', 'YOUR_API_KEY');

在控制器中使用 Yo

将 Yo 组件添加到控制器中,或者添加到 AppController 以便在所有控制器中使用。

调用 $this->Yo->all() 向所有人发送 YO,或者调用 $this->Yo->user('USERNAME') 向 USERNAME 发送 YO。

查看下面的示例

class UsersController extends AppController {

    // Add the component
    public $components = array('Yo.Yo');

    public function index() {
    	// send a Yo to everyone
    	$this->Yo->all();

    	// send a Yo to user USERNAME
    	$this->Yo->user('USERNAME');
    }

}

在模型中使用 Yo

如果你想在模型创建、更新或删除时获取 Yo,请使用包含的行为。

在关注的模型中添加 $actsAs = array('Yo.Yo')。默认情况下,只有当记录创建时才会 Yo。如果你还关心更新和删除,你需要修改选项。

默认情况下,行为使用 $this->Yo->all() 发送 Yo。如果你想只向一个用户发送,请在添加行为时修改 $actsAs 中的设置。

查看下面的示例

class User extends AppModel {
	
	// These settings are defaults.
	public $actsAs = array(
		'Yo.Yo' => array(
			'afterSave' => true,
			'afterUpdate' => false,
			'afterDelete' => false,
			'username' => '' // set a username so it doesn't send to everyone
		)
	);
}

许可证

MIT