xs-khairul / pac04
为 Wpmet 插件提供的工具包,用于服务故事、通知、横幅和评分
v1.0.0
2023-02-28 06:06 UTC
README
# 包概述
- Wpmet 插件工具辅助包,用于横幅、通知、故事和评分。
- 我们将这些类合并为一个 composer 包。
- 使用此辅助包,我们将这些类的功能集中在包管理器中(因此,对于这些功能的任何更新或全局修改,无需手动操作或依赖我们的插件)
Composer 和构建
composer 是一个 PHP 依赖管理器,负责处理项目的所有依赖项,它通过在 autoload.php 文件中映射来自动化命名空间初始化和调用,我们只需在它的 json 文件 composer.json 中指定根目录即可,我们还可以在此处配置其依赖项、作者和包名等。
composer.json 文件示例
{ "name": "xs-khairul/pac04", "description": "Utility packages for Wpmet plugin, It will be used to serve Stories, Notice , Banner and Ratings", "version": "v1.0.0", "type": "library", "license": "GPL-3.0-only", "autoload": { "psr-4": { "Wpmett\\UtilityPackage\\": "src/" } }, "authors": [ { "name": "XpeedStudio", "email": "info@xpeedstudio.com" }, { "name": "Wpmet", "email": "info@xpeedstudio.com" } ], "minimum-stability": "stable", "require": { }, "require-dev": { } }
说明
- namespace "Wpmett\UtilityPackage\" 在 composer 调用时直接指向 src/ 文件夹
- require 如果该项目需要其他包。
- required-dev 如果该项目需要其他包,仅用于开发目的。
通过 CLI 安装此包
composer require xs-khairul/pac04
使用功能示例
/** * Show WPMET stories widget in dashboard */ \Wpmett\UtilityPackage\Stories\Stories::instance( 'elementskit-lite' ) // ->is_test(true) ->set_filter( $filter_string ) ->set_plugin( 'ElementsKit', 'https://wpmet.com/plugin/elementskit/' ) ->set_api_url( 'https://api.wpmet.com/public/stories/' ) ->call(); /** * Show WPMET banner (codename: jhanda) */ \Wpmett\UtilityPackage\Banner\Banner::instance( 'elementskit-lite' ) // ->is_test(true) ->set_filter( ltrim( $filter_string, ',' ) ) ->set_api_url( 'https://api.wpmet.com/public/jhanda' ) ->set_plugin_screens( 'edit-elementskit_template' ) ->set_plugin_screens( 'toplevel_page_elementskit' ) ->call();