README

版本 1.1.4，2023年9月24日

                  ___           ,-.  
        ,---,   ,--.'|_     ,--/-/|  
       /_ ./|   |--| :,'  ,--. :/ |  
 ,---, |--' :   :--: ' :  :--: ' /   
/___/ \.--: | .;__,'  /   |--'  /    
 .--\  \ ,' ' |--|   |    '--|  :    
  \--;  `  ,' :__,'| :    |--|   \   
   \--\    '    '--: |__  '--: |. \  
    '--\   |    |--| '.'| |--| ' \ \ 
     \--;  ;    ;--:    ; '--: |--'  
      :--\  \   |--,   /  ;--|,'     
       \--' ;    ---`-'   '--'       
        `--`  Y i i  T o o l k i t

关于

YTK 是一个用于 php 网络框架 Yii (版本 1.11) 的函数和组件集合。该工具包旨在与 Yii 的 bootstrap 扩展一起使用。

安装

将此项目复制到 Yii 项目的扩展文件夹 protected\extensions\ytk

使用 composer 安装

可以使用 composer 从 Packagist 安装 ytk，代码如下 "require": "aspott/ytk"

配置

要使用 ytk 中的组件，请在 protected\config\main.php 文件中注册 ytk 以进行自动加载，以下代码片段（手动安装后）

// autoloading model and component classes
'import'=>array(
	'application.models.*',
	'application.components.*',
	'application.extensions.ytk.*',     // <-- add this entry
),

如果使用了 composer，别名必须更改。使用 Ytk 的文件别名（需要在 yii 的 config.php 中定义，在返回配置数组的语句之上）

Yii::setPathOfAlias('ytk', dirname(__FILE__).'/../extensions/vendor/aspott/ytk');

require 'protected/extensions/vendor/autoload.php';

最后一行调用 composer 的自动加载脚本，该脚本可能也由其他 composer 加载的扩展需要。使用 setPathOfAlias，可以将 ytk 组件的引用从 application.extensions.ytk.ytk 简化为 ytk.Ytk。确保在 Linux 上后者 Ytk 以大写字母开头（因为文件名区分大小写）。因此，使用 composer 的别名将导入数组简化如下

'import'=>array(
	'application.models.*',
	// ...
	'ytk.*',                            // <-- see the shortend syntax thanks to aliasing
),

要将 Ytk 的 markdown 渲染器作为视图使用，请将以下条目添加到 config/main.php 文件中的 components 部分

// application components
'components'=>array(
    // [...] some components

    // renderer component for markdown pages simiar to the views/site/page rendering
    'viewRenderer' => array(
        'class'=>'YtkMdViewRenderer',
    ),
    // [...] some more components
),

要使用该软件包中的 JavaScript 组件/资产，请将 ytk 组件添加到主配置文件 components 下的

'ytk'=>array(
    'class'=>'application.extensions.ytk.Ytk',
),

此外，在使用别名时，这里将简化为 'ytk.Ytk'。

此外，如果需要资产管理，ytk 组件必须在 protected/views/layout/main.php 中直接在 <body> 之后（如果它是在 bootstrap 组件的相应初始化调用之后使用的）初始化

<?php Yii::app()->ytk->init();?>

组件的使用

该软件包提供的组件（例如 ytktile）可以使用以下方式使用

$this->widget('application.extensions.ytk.YtkTile', array(
    'header'=>'Min Example',
    'labels'=>array('X'=>'primary'),
    'body'=>'Some content',
));

使用别名，组件的名称也简化为 'ytk.YtkTile'。

可以通过在前面加上 Ytk:: 来简单调用 Ytk 命名空间中的函数

echo Ytk::EncodeSuccess('myLabel');

在使用 JavaScript 扩展（如 chart.js）之前，请在每个视图文件中添加以下行

Yii::app()->ytk->register('chartjs');

致谢

Ytk 随带一套 MIT 或 LGPL 许可的 php 和 JavaScript 库。由于这些库在 Web 项目的资产目录中公开，所有第三方代码都完全以源代码的形式提供。

许可证

YTK 使用 MIT 许可证，这是一种弱版权的开源许可证。

aspott / ytk

维护者

详细信息

README

关于

安装

使用 composer 安装

配置

组件的使用

致谢

许可证