ballstatecber/datacenter-plugin-cakephp4

Ball State CBER 数据中心插件用于 CakePHP 4

安装: 187

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

语言:JavaScript

类型:cakephp-plugin

dev-master 2021-04-23 15:50 UTC

This package is auto-updated.

Last update: 2024-09-23 23:10:05 UTC


README

安装

  • 使用 composer 在您的 CakePHP 应用程序中安装此插件。

    composer require ballstatecber/datacenter-plugin-cakephp4:dev-master
    
  • App\Application:bootstrap() 中添加 $this->addPlugin('DataCenter');

  • AppController 继承 DataCenter\Controller\AppController

配置

  • 将插件的 config/datacenter.php 配置文件复制到应用程序的 config 目录
  • 在复制的文件中设置 'DataCenter.siteTitle''DataCenter.siteUrl'
  • 根据需要更改其他值
  • 在文件中注释掉或删除行,以便回退到插件的默认配置值

视图层

页面标题

  • 在每个操作视图变量中设置 $pageTitle,您希望将站点标题与页面标题一起添加并显示为标题。
  • $hidePageTitle 视图变量设置为 true 以仅将标题放入 <title> 并防止其显示。
  • $linkPageTitle 设置为 true 以将页面标题链接到当前页面。

布局

用以下内容替换 templates/layout/default.php

<?php
/**
 * @var \App\View\AppView $this
 */

$this->extend('DataCenter.default');

// If you have a /templates/elements/sidebar.php file
$this->assign('sidebar', $this->element('sidebar'));
?>

<div id="content">
    <?= $this->fetch('content') ?>
</div>

页眉

如果您想在页眉和主要内容之间有页眉或其他内容,请填写 templates/layout/default.php 中的 site_title 视图块。示例

<?php
    use Cake\Core\Configure;
?>
<?php $this->append('site_title'); ?>
    <h1>
        <a href="/">
            <img src="/img/masthead.png" alt="<?= Configure::read('DataCenter.siteTitle') ?>" />
        </a>
    </h1>
<?php $this->end(); ?>
  • 这样的页眉图像将调整以适应视口,但理想情况下应该是 1,140px 宽
  • 如果您使用文本而不是图像,请使用 <h1 class="text"> 来应用填充、圆角和背景颜色。

覆盖侧边栏宽度

默认情况下,侧边栏在大宽度设备中为两列宽,在中宽度设备中为三列宽(在小宽度设备中单独显示)。要覆盖此设置,请设置 $lgSidebarWidth 和/或 $mdSidebarWidth 视图变量

$this->set([
    'lgSidebarWidth' => 3,
    'mdSidebarWidth' => 2,
]);

CSS

webroot/css/style.scss 中创建这些导入的顶部

@import "./cake.css";
@import "../../vendor/twbs/bootstrap/scss/bootstrap.scss";
@import "../../vendor/ballstatecber/datacenter-plugin-cakephp4/webroot/css/datacenter.scss";

如果您正在使用标签编辑器,也请添加

@import "../../vendor/ballstatecber/datacenter-plugin-cakephp4/webroot/css/tag_editor.scss";

电子邮件

  • Mailer 类继承 DataCenter\Mailer\DataCenterMailer 以使用插件的默认布局和设置
  • 如果使用 DataCenter.default 电子邮件布局,创建名为 email_signature_html.phpemail_signature_text.php 的元素以覆盖默认签名
  • 这些元素可以 return false 来禁用电子邮件签名

身份验证/授权

有关使用插件的常用身份验证设置的信息,请参阅插件的 身份验证文档

社交媒体元标签

有关为社交媒体网站设置抓取页面时使用的信息的说明,请参阅插件的 社交媒体标签文档