loadsys / cakephp_giftwrap
此包已被弃用且不再维护。没有建议的替代包。
CakePHP Presenter/Decorator 插件
dev-master
2014-03-13 04:49 UTC
Requires
- php: >=5.3.0
- composer/installers: *
This package is not auto-updated.
Last update: 2022-02-01 12:31:50 UTC
README
需求
- CakePHP >= 2.1
- PHP 5.3+
安装
Git
git clone git@github.com:loadsys/CakePHP-GiftWrap.git Plugin/GiftWrap
Composer
- 将以下内容添加到您的
composer.json
文件中
"require": { "loadsys/cakephp_giftwrap": "dev-master" }
用法
- 确保通过调用
CakePlugin::load('GiftWrap', array('bootstrap' => true));
在app/Config/bootstrap.php
中加载插件 - @TODO 完成此部分
API
组件 API
PresenterComponent::uses($className)
- $className String 带或不带 Presenter 部分的类名。
设置默认展示器的类。
PresenterComponent::viewVar($varName)
- $varName String 默认展示器将被设置的变量名。
设置默认展示器将设置的变量名。
PresenterComponent::defaultClass($className)
- $className String 带或不带 Presenter 部分的类名。
设置当常规命名的展示器类不存在时用作回退的类。
PresenterComponent::options($options)
- $options Array
- contextKey String 展示器中将作为上下文的属性。默认是
model
。
- contextKey String 展示器中将作为上下文的属性。默认是
设置传递给默认展示器创建的选项数组。
PresenterComponent::create($className, $data, $options)
- $className String 带或不带 Presenter 部分的类名。
- $data Mixed 传递给展示器创建的数据。
- $options Array 传递给展示器创建的选项。
使用给定数据和选项创建指定的展示器类的新实例。
PresenterComponent::set($keyOrArray, $value)
- $keyOrArray Mixed 可以是一个字符串键或一个键值对的数组。
- $value Mixed 当第一个参数是字符串键时设置的值。
通过传递键和值,或键值对数组设置默认展示器数据。
PresenterComponent::setPresenter($key, $className, $data, $options)
- $key String 属性在默认展示器上设置对象。
- $className String 带或不带 Presenter 部分的类名。
- $data Array 新展示器实例的数据。
- $options 数组 新演示者实例的选项。
使用提供的数据和选项创建一个指定演示者类的实例,并将其设置到默认演示者的键上。
PresenterComponent::setEachPresenter($key, $className, $array, $options)
- $key String 属性在默认展示器上设置对象。
- $className String 带或不带 Presenter 部分的类名。
- $array 数组 包含数据的列表,每个元素都被演示者包装。
- $options 数组 新演示者实例的选项。
创建一个包装提供的数组的迭代器。数组的每个元素都成为指定演示者类名的实例,其中数据是数组的当前元素,而选项适用于所有实例。
PresenterComponent::setDecorator($key, $className, $context, $extra, $options)
- $key String 属性在默认展示器上设置对象。
- $className String 带或不带 Presenter 部分的类名。
- $context 混合类型 设置到演示者 contextKey 属性上的数据。
- $extra 数组 新演示者实例的数据。
- $options 数组 新演示者实例的选项。
创建一个指定演示者类名的实例。变量 $context 设置为演示者的 context 属性,而 $extra
数据用于创建演示者。
PresenterComponent::setEachDecorator($key, $className, $contexts, $extra, $options)
- $key String 属性在默认展示器上设置对象。
- $className String 带或不带 Presenter 部分的类名。
- $contexts 数组 设置到演示者 contextKey 属性的数据列表。
- $extra 数组 新演示者实例的数据。
- $options 数组 新演示者实例的选项。
创建一个包装上下文的迭代器。每个上下文都成为指定演示者类名的实例。演示者使用 $extra
中提供的数据创建,上下文设置在演示者实例的 context 属性上。