文档导航

Octobercms · 4.x

文档列表

cms

AJAX 框架使用

本文档介绍了 October CMS 的 AJAX 框架,它允许在不刷新页面的情况下从服务器加载数据。文档涵盖了如何在 CMS 主题和管理面板中集成和使用 AJAX,包括 JavaScript API 和数据属性 API 两种方式,以及通过 Twig 标签引入框架并启用表单验证、加载指示器等额外功能。

Tailor 概述

本文档介绍Tailor功能,这是一个用于通过YAML蓝图定义网站内容结构(如博客)的工具。它自动生成后端管理界面并提供前端CMS组件,从而简化内容定义,避免传统插件开发。文档详述了蓝图的定义方式与目录结构。

概述

本文档概述了 October CMS 主题,涵盖其配置方式、文件结构、基于文件的管理特性和版本控制,并介绍了主题中包含的页面、局部视图、布局和内容文件等核心组成部分。

数据属性 API

本文档介绍数据属性API,允许通过HTML属性直接发起AJAX请求,无需编写JavaScript。它详细列举并说明了各项AJAX数据属性及其用途,旨在简化前端交互。

AJAX 处理程序

本文档详细介绍了在基于PHP的CMS/框架中创建、定义和调用AJAX事件处理程序的方法。它涵盖了处理器的用途、定义位置、优先级、注册机制以及如何通过数据属性或JavaScript API进行调用,以实现动态页面更新和服务器通信。

可观测控件

本文档详细介绍了如何在 October CMS 中利用 MutationObserver 实现可观测 HTML 控件。这些控件能自动检测自身被添加或移除页面的事件,支持 AJAX 或 Turbo 路由更新。通过定义控件名称、类及 `init`/`dispose` 等生命周期方法,可轻松注册和配置这些响应 DOM 变化的组件。

JavaScript API 使用

介绍October CMS框架下JavaScript API的应用,它比数据属性API更强大。文档详细说明了如何使用JavaScript方法处理表单元素和AJAX请求,包括参数设置、目标元素选择及October CMS特有的选项配置。

PJAX详解

极速路由器(Turbo路由)通过PJAX(Push State和AJAX)技术,提供高性能单页应用体验,无需复杂客户端框架。它实现客户端页面无刷新切换,并支持链接编程访问、禁用特定页面或链接的PJAX、以及滚动行为控制,旨在优化网站导航性能。

AJAX 局部更新

本文档详细介绍了通过AJAX更新局部视图的方法。内容涵盖了拉取部分更新、使用特定模板标签(如AJAX Partial Twig标签)渲染和管理局部视图(支持自更新),以及全局部分更新的实现。

集合组件

本文档描述了一个在页面上显示条目集合的“集合”组件。它详细介绍了该组件的功能、在页面、布局或局部视图中的应用,以及通过 `handle`、`recordsPerPage` 和 `pageNumber` 等属性进行配置的方法,特别是支持内容分页展示。

全局组件

该文档介绍了一个用于在页面、布局和局部之间共享全局记录或配置的组件。它详细说明了组件的用法、支持的属性(如句柄)以及如何在视图中访问和显示这些全局数据。

资源组件

本文档详细介绍了“resources”组件。该组件用于在页面、布局或局部视图中管理和注入JavaScript、LESS、SCSS和CSS等前端资源。它支持创建新变量和添加页面头部信息,并通过特定属性配置需加载的资源文件路径。

Section组件

介绍网站分区组件的定义、可用属性及其后端预览用途。

站点选择器

该文档介绍了“站点选择器”组件,用于管理和处理多站点配置。内容涵盖其基本用法,如站点间切换、为不同页面加载站点数据,以及通过全局事件翻译URL参数。旨在简化多站点环境下的开发与集成。

文件下载

本指南阐述 October CMS 文件下载功能。内容涵盖通过HTML属性触发下载、指定文件名、新窗口预览,以及在AJAX处理器中处理多种文件源(如本地、字符串、存储服务和模型附件)的下载响应。

Flash 消息

本文档详细介绍了如何在Web应用中实现和配置瞬时消息(Flash Messages)。内容涵盖其设置、AJAX集成、重定向处理、消息类型筛选、与验证功能的协同,以及用于显示请求进度和结果的加载提示等实用功能。

加载指示器

本文档介绍AJAX请求中的加载指示器、进度条和加载按钮,用于提供用户反馈、优化体验并防止重复提交,包括其显示、禁用与控制方法。

模态框

本文档详细介绍了如何利用AJAX和Bootstrap 5实现模态框,包括动态加载模态内容、设置模态触发器、定义模态容器以及如何通过 `data-request-loading` 属性显示加载状态,从而实现局部更新的模态框体验。

分页

本篇文档详细介绍了 October CMS 的分页功能,涵盖了数据获取、多实例分页处理、自定义标记以及 AJAX 分页的实现和使用。

轮询与懒加载

本文档阐述了 AJAX 轮询技术,用于实现页面内容的延迟加载与周期性更新。它详细介绍了如何通过特定属性触发和重复 AJAX 请求,常与 Twig 部件结合,以实现内容懒加载和自动化刷新,例如倒计时器。文档还涵盖了服务器负载考量及停止轮询机制,为动态交互式前端开发提供指导。

重定向

本文档详细介绍了在Web应用中实现页面重定向的各种方法。内容涵盖AJAX处理器重定向、跳转至CMS页面、Twig函数重定向,以及通过AJAX框架提供的特定属性处理请求后的跳转。

文件上传

本文档详细介绍了在 October CMS 中实现文件上传的多种方法。内容涵盖通过表单上传单文件或多文件、利用 AJAX 处理上传逻辑、配置存储路径、进行文件验证,以及如何将文件直接关联到模型(包括 Tailor 模型)。

表单验证

文档介绍了在AJAX框架中实现表单验证的多种方法,包括闪存验证、内联验证、抛出验证异常和单个字段验证,旨在高效地检查用户输入并显示错误信息。

媒体管理器

本文档详细介绍了 October CMS 内置的媒体管理器,包括其基本功能、媒体资产的链接方法、通过 `config/media.php` 文件进行的各项配置,以及如何自定义音频和视频播放器。旨在帮助用户高效管理和整合其网站的媒体资源。

提供商

本文档详细介绍了如何将媒体管理器从默认的本地存储配置为使用 Amazon S3。它涵盖了安装必要的 Flysystem S3 软件包、修改文件系统配置、创建和配置 Amazon S3 存储桶,以及设置存储桶策略使其文件可公开访问的步骤。

构建 API

本文档详细介绍了如何在基于主题的系统中,利用页面作为API端点来构建和发送JSON响应。它指导用户通过Twig函数处理模型、集合的JSON序列化,并运用Twig条件和HTTP方法,为Vue.js、React等客户端框架提供API服务。

多站点

此文档介绍了 October CMS 的多站点功能。它详细说明了如何在一个安装中管理多个网站,根据域名分配内容和进行本地化翻译。文档还指导用户创建和配置各个站点,涵盖了启用状态、名称、主题、区域设置、时区和匹配主机名等关键设置。

Blueprints

本文档详细介绍了入口蓝图,它用于定义网站区域的标准内容结构和组织方式。文档阐述了入口类型如何支持多条目,并列出了入口蓝图所支持的各项属性。

定制组件

介绍了如何创建、定义和扩展自定义组件,以满足应用特定的用户界面和功能需求。

Tailor

本文档详细介绍了 Tailor CMS 中的内容字段。它阐述了内容字段作为 Tailor 模块的基石作用,如何通过蓝图配置和显示字段,以及它们的通用属性。文档还指导如何扩展 Tailor 以构建自定义内容字段。

Tailor PHP 模型

本文档介绍了如何使用 PHP 与 Tailor 系统进行交互。它详细阐述了 Tailor 的各种模型类(如 entry、structure 等)及其对应的蓝图类型,并解释了如何通过这些模型操作内容,包括模型属性的说明。

定义导航

本文档详细介绍了如何使用蓝图文件中的 `navigation` 属性定义和自定义应用程序的后台导航菜单。内容包括设置菜单项的图标、显示顺序以及本地化标签等配置,为开发者提供灵活的菜单管理指南。

子主题

介绍子主题的继承与定制,主题锁定文件防止更新覆盖,以及命令行创建新主题和子主题的方法。

组件

本文档概述了October CMS组件的基础知识。组件是扩展网站功能的关键特性,能输出HTML、处理AJAX请求、表单回传及管理页面生命周期。文中详细讲解了如何在页面、局部和布局中添加和配置组件,并介绍了组件属性的使用。

内容块

该文档详细介绍系统中的内容块(用于静态内容)及局部文件(用于动态内容)。它阐述内容块的存放位置、支持的文件扩展名(如HTML、Markdown)及其对后端编辑体验的影响。

数据库主题

本文档介绍了数据库驱动主题功能,旨在解决文件系统写入权限受限时修改CMS模板的问题。它阐述了如何将主题更改存储在数据库中,包括单个主题启用、全局配置,以及从数据库导入或删除模板的命令行操作,并指出资产文件不受此功能影响。

布局

阐述模板系统中的页面布局,包括其定义、文件结构、与页面内容结合的方式,以及通过局部文件共享通用元素,用于构建统一的页面框架。

本地化

本文档详细介绍了如何在网站主题中实现本地化。内容涵盖本地化文件的结构(如 `lang` 目录下的 JSON 文件),语言键的定义、自动注册及在主题内容和后端表单中的使用,以及如何在 Twig 模板中访问翻译字符串。

页面

本技术文档详细介绍了如何在 October CMS 中创建和配置页面。内容涵盖页面模板文件结构、必需的 Twig 模板和配置部分、可选的 PHP 部分,并阐述页面配置参数在路由、渲染及组件集成中的作用。

局部视图

本文档详细介绍了局部视图(Partial Views)的概念、用途和实现。它涵盖了局部视图的定义、文件结构、可选配置(如描述和组件)、通过Twig标签渲染,以及如何向局部视图传递变量,旨在帮助开发者有效重用HTML和动态更新页面内容。

初始化

本文档详细阐述主题初始化过程,包括使用种子脚本导入示例内容、数据库与 Tailor 蓝图,支持 Artisan 命令或管理面板操作,并介绍种子目录结构。

设置

本指南介绍 October CMS 主题的设置与配置,详细说明 theme.yaml 文件的结构、支持字段和目录位置,及其在主题发布中的作用。

片段

本文介绍片段(Snippets)作为可重用、可配置的内容块,可插入富文本或Markdown编辑器。它们可定义为局部文件或组件,支持嵌入视频、地图及第三方集成等多种应用场景,并阐述了其使用Twig过滤器进行渲染的机制,旨在提高内容编辑的灵活性和效率。

element

可用命令

本文档介绍了October CMS提供的命令行界面(CLI)命令和实用工具。它详细说明了如何使用这些基于Laravel Artisan的命令来管理平台、加快开发,包括更新核心与插件、执行数据库迁移(正向与反向),以及重置管理员密码。文档也提及了自定义命令的能力。

可用图标

介绍 October CMS 中可用的图标库,包括 Phosphor 和 October 自定义图标包。文档详细说明了各图标包的特点、适用场景及其图标名称的定义规范。

条目字段

这份文档描述了一种条目字段,用于通过 UUID 或句柄链接到其他条目。它详细说明了该字段支持的属性,例如指定相关蓝图的 'source' 属性。

Mixin 字段

该文档介绍了混入字段(Mixin Fields),即包含另一组字段的可复用字段集。它解释了如何通过蓝图句柄或UUID引用和引入混入,并提供了使用时的识别建议。文档还指向了蓝图和Tailor蓝图以获取更多定义信息。

嵌套字段

文档描述了“嵌套项字段”的用法,即如何在当前记录中创建嵌套记录,并列出了该字段支持的各项配置属性。

定义选项

本文档详细指导如何配置 `options`、`optionsMethod` 和 `optionsPreset` 属性。它涵盖选项数组的键值对定义、复杂值的指定方法(如描述、图标、颜色),以及选项预设的使用。

筛选作用域

本文档详细介绍了后端列表中使用的过滤范围(filter scopes)。它解释了过滤器作用域的定义、在控制器中的引用方式,并列举了复选框、文本、数字、下拉框等多种可用作用域类型,以及它们的属性配置。

复选框

本文档介绍了“复选框作用域”,一个用作二元复选框的过滤器,用于向列表应用预定义的条件或查询。它支持开启/关闭状态(1/0),并详细说明了其可配置属性,如默认选中状态和自定义SQL条件。

日期

本文档介绍如何使用日期值进行数据筛选,包括多种条件逻辑,并详细说明了如 `minDate` 等可用的筛选器属性,以实现精确的日期范围控制和选择。

下拉菜单

描述用于从多个项目中单选过滤的下拉组件,并列出其可配置属性。

范围过滤

介绍如何在组范围内对多个项目进行过滤。文档详细说明了通过相关模型或预定义选项数组实现过滤的方法,并列出了配置过滤器(如选项及其获取方式)的可用属性。

数字

本文档详细介绍了数字范围过滤器的使用方法,包括如何利用数值和条件逻辑进行数据过滤,并列出了该过滤器支持的各项属性及其说明。

开关

本文档介绍了“切换范围”组件,阐述其作为开关在开启、关闭或不确定状态间切换的功能,并详细说明了默认值等筛选器配置属性。

文本

介绍文本范围筛选器及其属性,支持或逻辑,用于数据筛选。

表单字段

本文档详细介绍了系统(如CMS或后台管理界面)中可用的表单字段、用户界面元素和表单小部件。它区分了通用字段、用于布局的UI元素和提供复杂功能的特定小部件,并列出了包括文本、数字、下拉列表、日期选择器等多种类型的可用字段及其用途。

气泡选择器

文档介绍了气泡/气球选择器字段,这是一种单选列表字段。它阐述了该字段的选项定义方式,并详细列出了包括 `label` 和 `default` 在内的常用配置属性及其功能说明。

复选框

本文档详细介绍了复选框字段及其常用属性,包括标签、默认值和注释。它指导用户如何配置这些属性以控制复选框的显示和行为,例如设置默认选中状态或添加附带文本。

复选框列表

本文档介绍复选框列表字段的配置与用法。涵盖其渲染方式、选项定义方法,并列出支持的`label`、`options`等字段属性,同时提及与下拉和单选字段类型的相似之处。

下拉菜单

本文档详细介绍了下拉字段(Dropdown Field)的实现和配置。它涵盖了如何渲染带指定选项的下拉菜单,提供了多种设置选项的方法,并列出了所有受支持的常用字段属性,以帮助开发者高效定制和使用下拉字段。

Email

本文档详细介绍了电子邮件输入字段的渲染机制(包括移动端专用键盘触发)、常用属性(如label、placeholder、default、comment)及其配置。内容涵盖了从用户界面呈现到服务器端验证的整个生命周期。

数字

该文档介绍数字字段,它是一个接受数字输入的单行文本框。详细说明了其支持的常用属性,如标签、默认值、最小值、最大值和步长,以帮助用户理解和配置此字段的行为。

密码

本文档描述了密码字段组件,该组件用于捕获如密码等敏感值。内容涵盖了其常用属性,并关联到敏感表单部件的使用。

单选

单选列表字段配置指南,详细说明其单选功能、选项定义及常用属性(如label、default)。

开关

本文档详细介绍了开关字段,它作为一种拨动开关式的表单字段,功能类似复选框。内容涵盖其渲染方式、支持的label、default、comment等常用属性及其配置方法。

文本

本文档详细介绍了文本字段(单行文本框)的概念及其常用配置属性,包括标签、占位符、默认值和注释,旨在指导用户有效地定义和使用表单中的文本输入字段。

文本域

介绍文本域字段(多行文本框)的渲染方式及其支持的常用属性和配置选项。

提示

本文档描述了提示字段UI元素,强调其用户可关闭容器特性。它详细列举了该元素支持的字段属性,如label和comment,以指导用户配置和使用。

视图

本文档描述了UI字段元素如何通过partial进行渲染,包括partial视图文件的引用方式或命名规则。它还详细介绍了支持的字段属性,如'path',以便于配置和自定义partial的渲染行为。

标尺

本文档描述了“标尺字段”这一UI元素,它主要用于在表单中渲染一条水平线,以视觉上分隔不同的内容区域,提升表单的可读性和组织性。

区段

本文档描述了区段字段UI元素及其用法,该元素用于在界面中呈现段落标题和副标题。它列出了受支持的字段属性,并解释了如何使用`label`和`comment`属性来定义标题和辅助文本内容。

Boxs

介绍 October CMS 中 Boxes 插件提供的盒子字段。该字段提供了一个可视化页面编辑器,功能类似于前端页面构建器。文档涵盖插件的安装、在 Tailor 后台表单中定义和显示盒子编辑器,以及如何在前端获取并渲染其 HTML 内容。

代码

本文档介绍了代码编辑器字段,它用于渲染格式化代码或标记的纯文本编辑器,并详细说明了其支持的配置属性及其与后端偏好设置的继承关系。

颜色

本文档介绍了颜色选择器字段及其支持的常用属性,用于在表单中渲染一个十六进制颜色选择控件。

货币

本文档详细介绍了 October CMS 中的货币字段表单微件。它涵盖了货币插件的安装、如何定义和配置货币输入字段,以及其支持的属性和用法,旨在帮助用户在表单中集成和管理货币值输入。

数据表

本技术文档介绍了数据表字段功能,它能够以可编辑网格的形式渲染和管理多行多列的数据。文档详细说明了如何在模型中使用该功能(如通过jsonable属性),并列出了支持的字段属性。

日期

文档详细介绍了日期选择器字段的功能与用途,并阐述了其支持的各项属性(如label),指导用户如何配置和使用此用于选择日期时间的文本字段。

文件上传

该文档详细介绍了文件上传字段的用法。内容涵盖了如何渲染文件上传器以处理图片或常规文件,并列出了其支持的各项字段属性,例如设置显示标签等。

Markdown

Markdown编辑器字段的属性配置指南,详细说明其各项参数及用法。

媒体查找器

本文档介绍媒体查找器字段。它允许用户从媒体管理器库中选择文件,并返回文件的相对路径。文档详细阐述了该字段的渲染方式、交互流程以及支持的各项属性及其配置,旨在指导开发者有效集成和使用此媒体选择组件。

嵌套表单

介绍如何渲染和配置嵌套表单字段,支持内联或外部YAML定义,并阐述了其常用属性。

页面查找

本文档介绍页面查找字段的功能、工作原理及其配置。该字段用于选择页面链接,通过页面选择器定位,并支持label、default等属性以自定义其行为和显示。

记录查找器

介绍记录查找器字段,该字段用于渲染并显示相关记录详情。用户可通过弹窗列表搜索大量记录,但仅支持单数关系。文档详细说明了其功能、用途及支持的字段属性。

关联

本文档详细介绍了关联字段的渲染机制,包括根据关系类型(单一/多重)自动生成下拉列表或复选框,以及如何定义显示标签和支持的各项字段属性。

重复器

该文档介绍了重复器字段及其功能,即渲染重复的表单字段,并详细说明了其支持的各项属性。

富文本编辑器

本文档详细介绍了富文本编辑器(所见即所得编辑器)的渲染和使用方法。它列举并解释了该编辑器支持的各项字段属性,旨在帮助用户进行配置和开发。

敏感字段

此文档介绍敏感字段组件,专为安全处理API密钥、密码等敏感信息设计。它提供可见性切换、加载时占位符替换,并通过AJAX按需安全加载原始值。

标签列表

本文档详细介绍了标签列表字段这一表单部件,包括其渲染方式和支持的各项常用字段属性,如‘label’,旨在帮助用户理解和配置此组件。

检查器类型

本文档详细介绍了CMS组件类中可用的检查器类型。它通过`type`属性标识,列举了字符串、文本、自动完成、复选框、下拉菜单等多种数据和UI类型,并说明了如何定义和配置这些属性参数。

自动补全检查器

本文档介绍自动补全检查器类型,阐述其工作原理、特性(如自动完成功能)、选项配置方式(静态或动态加载)、输出格式(数组),并详细列出其常用的配置属性。

复选框检查器

本文档详细介绍了复选框检查器类型的属性定义,包括其界面表示、参数输入、输出格式以及常用配置项如标题、描述和默认值。

字典检查器

本文档介绍了字典检查器类型,该类型提供一个简单的用户界面来创建和管理键值对。它详细说明了其配置参数(如标题、描述和默认值)、生成输出的格式以及额外的验证支持。

下拉菜单检查器

本技术文档描述了下拉检查器类型,这是一种用于从预设选项中进行选择的配置字段或UI组件。它详细介绍了如何定义静态或动态选项,配置相关属性(如标题和描述),以及选择后生成的字符串输出。

对象检查器

本文档介绍“对象检查器类型”,用于定义具有特定属性且可由用户编辑的对象。它详细说明如何通过 `attributes` 属性配置这些对象属性(如文本字段和下拉菜单),并列出支持的常用配置值,以帮助用户高效构建和管理可编辑的对象结构。

对象列表检查器

本文档详细介绍了对象列表检查器类型,它允许用户创建和管理具有预定义结构的多个对象实例。内容涵盖如何通过参数定义对象属性、指定UI显示标题、支持的属性类型,以及生成的非关联数组输出格式。适用于需要自定义结构化对象列表的场景。

Set检查器

本文档详细介绍了“检查器类型”的设置与配置。该类型用于从预定义选项中进行多项选择,输出为选定项的数组值。文档还说明了其常用的配置属性,如标题和描述。

字符串检查器

本文档介绍字符串检查器类型,一种简单的文本输入字段,并说明其参数、输出格式及常用配置属性。

字符串列表检查器

本文档详细介绍字符串列表检查器类型,一个允许用户通过弹出编辑器输入字符串列表的UI组件。内容涵盖其输入输出机制及`title`、`description`等常用配置属性。

文本检查器

本文档介绍了一种用于在弹出窗口中输入多行长文本的编辑器类型,并详细说明了其可选配置参数,例如标题、描述和默认值。

本文档详细介绍了列表列的定义和配置。它涵盖了多种可用的列类型(如文本、数字、图片、联动等)及其各自的属性,主要用于后端列表和关联控制器中数据展示的定制化。

颜色

介绍颜色选择器列的功能,用于显示通过拾色器选择的颜色。

货币

本文档详细介绍了 October CMS 中,由货币插件引入的货币列功能。它涵盖了该列的安装、使用方法,以及如何通过 `format`、`fromCode`、`toCode` 等属性对其进行格式化和配置,以显示不同货币的格式化值。

日期

详细说明了多种日期与时间列的显示与格式化方法,涵盖时区处理、自定义格式、相对时间及时间差展示。

图像

详细介绍了图像列的配置属性,涵盖图片宽度、高度、排序、缩放选项以及显示数量限制等。

链接

本文档详细介绍了如何配置和使用链接列。它涵盖了设置链接文本、指定超链接URL及添加自定义HTML属性等关键功能,旨在帮助用户在数据展示中创建可点击的页面链接,并提及了自动解析页面查找器链接值的能力。

数字

文档介绍如何在数据展示中配置和格式化列。重点讲解数字列的显示、自定义格式化(遵循PHP `sprintf()`规则),以及如何利用关系计数列类型统计和显示模型中相关联记录的数量。

视图

本文档说明了如何利用局部视图文件自定义渲染列内容,包括文件路径确定规则及支持的配置属性。

可选择

本文档介绍如何配置可选列。该列的显示值通过匹配记录数据与预设的下拉选项来确定。选项可通过 `options` 数组直接定义,或通过 `optionsMethod` 动态获取,用于实现基于匹配的显示逻辑。

汇总

本文档描述了如何配置和使用汇总列功能,以生成简洁的文本摘要。它详细介绍了摘要值的生成逻辑,包括去除HTML、按字符或字数限制长度并确保在词边界截断,以及如何自定义默认摘要长度和末尾后缀字符。

开关

配置切换列以在表格中显示布尔值的“开/关”状态,并支持自定义false和true的显示文本。

文本

描述文本列的显示功能及其对齐方式,如左对齐。

extend

后台导航

本文档指导开发者如何利用插件扩展后台导航菜单。内容涵盖注册顶级和子菜单项、配置本地化与用户权限、调整显示顺序,并通过控制器设置导航上下文以激活子菜单。

权限与角色

详细阐述了权限系统的运作机制,包括权限代码定义、嵌套结构,以及角色继承与用户直接分配权限时的覆盖逻辑。

后端用户

October CMS 后端用户管理指南,涵盖用户模型、权限、群组、认证流程及管理员密码重置方法。

CMS 组件

本指南阐述了如何在 CMS 插件中构建和注册组件。内容涵盖组件文件结构、PHP 类定义、注册方法及属性配置。

控制台命令

本文档指导用户如何在插件中构建自定义控制台命令。它详细介绍了命令文件的创建、`handle`方法的实现,以及如何定义必需或可选参数和选项,以扩展应用程序的命令行功能。

仪表盘数据

文档阐述了 October CMS 的仪表盘系统,包括其灵活的仪表盘、小部件类型及可配置的访问权限。重点介绍了小部件如何利用服务器端数据源,通过维度和指标展示多样化数据。建议开发者优先创建数据源以满足报告需求,而非自定义小部件。

数据源

这是一个关于在插件化系统中创建和配置数据源的指南。文档详细介绍了如何通过扩展特定类来定义数据源,并要求每个数据源注册指标与维度。它还介绍了用于简化从数据库获取数据和构建查询的辅助类,旨在为插件提供灵活的数据集成方案。

报表小部件

介绍如何在插件中创建和定制后端报表小部件,涵盖注册、文件结构、类定义及视图模板,以便在仪表板或容器中展示数据。

Vue 小部件

本指南阐述如何基于 October CMS Vue 框架创建自定义仪表盘小部件。内容涵盖小部件注册、文件结构、AJAX数据交互与事件处理,助力开发者扩展仪表盘系统功能。

文件附件

本文档指导如何通过多态关系管理模型的文件附件,包括设置单个或多个附件、处理受保护文件上传。它还详细介绍了从用户上传、本地路径、原始数据或URL创建和关联新附件的多种操作方法。

数据库

本文档详细介绍了数据库操作,涵盖连接、查询以及管理数据库表和种子数据的方法。它阐述了使用原生 SQL、查询构建器和 Active Record 模型执行增删改查操作,并强调了参数绑定在防止 SQL 注入方面的作用。

Eloquent

介绍 Laravel Eloquent 集合,它是模型查询结果的实例,继承了基础集合的强大方法,并提供丰富的操作接口,用于高效管理和处理模型数据,实现流畅的数据操作如筛选、映射和迭代。

模型查询

本文档详细介绍了如何使用模型进行数据库查询。它涵盖了通过模型检索单个或多个数据记录、添加查询约束、访问模型属性的方法。强调模型作为查询构建器的作用,以及如何处理返回的集合结果,并提及了分块处理大量数据。

访问器和变异器

本文档详细讲解模型访问器和变异器,阐述如何定义它们,实现在从模型检索或设置属性时自动格式化与转换数据,如加密、日期或JSON处理,提升数据操作灵活性。

分页

本文档详细介绍了在查询和模型中实现数据分页的方法。它涵盖了`paginate`和`simplePaginate`等方法的基本用法,以及如何自动处理页码、每页显示数量和优化大型数据集的分页性能。

查询构建器

详细介绍数据库查询构建器,提供便捷流畅的接口来创建和运行数据库查询。涵盖了多种数据检索方式,包括获取记录、单行、单个值及值数组,并提及原生SQL。

关联关系

本文档详细介绍了如何在 October 框架中管理和使用模型关系。它涵盖了如何在模型类上定义多种类型的数据库关系,以及如何利用这些关系进行高效查询和数据访问,从而简化关联数据的处理。

模型序列化

该文档详细介绍了如何将模型及其关系序列化为数组或 JSON 格式,以便构建 JSON API。内容涵盖了基本转换方法、处理模型集合,以及如何控制序列化中包含或隐藏的属性,并能追加额外数据。

数据库迁移

文档详细介绍了数据库迁移和数据填充。它指导用户如何通过迁移文件构建、修改和填充数据库表,利用 `up` 和 `down` 方法进行版本控制和回滚。内容涵盖迁移文件的结构、生成、模式构建器使用,以及如何管理数据库连接和存储引擎。

Traits

阐述模型中各类特性及其实现方法,涵盖属性的可空、哈希、清除、加密与别名化等通用功能。

插件扩展

本指南阐述如何在 October CMS 中通过插件注册文件 Plugin.php 实现系统扩展,并解释其作为 Laravel 服务提供者的原理及可重写的方法。

字段依赖

本文介绍了表单字段的依赖关系和动态更新机制,通过AJAX实现字段刷新与属性交互。同时,阐述了如何通过模型方法筛选和操作表单字段的可见性及属性,并区分了表单上下文对值的影响。

表单控制器

本文档介绍了表单控制器行为的使用和配置,它提供了一个高效方案,简化了向后端页面添加创建、更新和预览数据表单功能的过程。通过自动化CRUD操作并结合模型、字段定义及YAML配置文件,开发者可以快速构建和管理数据录入界面。

表单小部件

文档介绍了如何开发和使用自定义表单部件,以扩展后端表单的控件类型,包括注册、文件结构、类定义及资源管理。

关系控制器

该文档介绍了关系控制器,这是一个用于在页面上管理复杂模型关联的控制器行为。它详细说明了如何通过YAML文件配置该行为,包括属性定义,并指出其常与表单控制器结合使用。

导入导出控制器

该文档介绍了导入导出控制器行为,一个提供数据导入(从CSV到数据库)和导出(从数据库到CSV)功能的组件。它通过导入和导出两个页面实现,并详细说明了其配置方法(包括模型、字段定义和YAML文件设置)以及如何在控制器中集成使用。

导入导出模型

本文介绍如何通过导入导出模型定义数据导入与导出的处理逻辑。重点讲解如何创建专用导入模型、实现数据处理方法,并说明这些模型可与控制器配合或直接在PHP中使用。

筛选小部件

介绍如何创建、注册和管理后端筛选器小部件,包括其文件结构、类定义和资源配置,以扩展插件的后端筛选功能。

筛选器

本文档详细介绍了如何在 October CMS 中实现和配置记录过滤功能,包括行为定义、筛选器作用域的设置以及筛选器依赖项的管理。

列表控制器

介绍列表控制器行为,这是一个控制器组件,用于在页面中轻松添加、管理和显示可排序、可搜索的记录列表。文档涵盖其实现、依赖以及通过YAML进行的详细配置。

排序与树

该文档介绍了 October CMS 中数据库记录的排序和重新排序功能。它阐述了如何通过 `structure` 属性启用此功能,利用各种模型特性(如嵌套集、可排序模型)进行支持,并在列表和关联控制器中配置,从而实现拖放式记录重排界面。

发布包

本指南详细阐述 October CMS 开发者如何使用 Composer 发布插件和主题到市场,内容涵盖作者注册、仓库设置、命名规范及版本控制等关键步骤。

使用 Laravel 包

本指南详细介绍了在 October CMS 插件中集成 Laravel 包的方法。内容涵盖了配置文件的处理、服务提供者与别名的注册,以及迁移与模型的适配,旨在帮助开发者在 October 插件环境中高效利用 Laravel 生态。

容器与服务提供者

深入探讨控制反转(IoC)容器的工作原理,讲解其依赖绑定、解析机制,以及服务提供者在应用程序引导中注册这些绑定的方式。

缓存配置

本文档详细介绍October CMS的缓存配置,涵盖如何选择与设置默认缓存驱动,支持Memcached、Redis等多种系统,并说明各驱动的安装先决条件与配置方法,同时提供性能优化建议。

集合类

详细介绍Laravel集合类,它为处理数据数组提供流畅的链式API。文档涵盖集合的创建、核心概念及丰富的数组操作方法,如映射、归约、过滤等。

事件

本文档详细介绍了应用中事件系统的基本用法。它基于简单的观察者模式,阐述了如何订阅和监听事件,以实现模块间的解耦通信和增强应用的可扩展性,并通过用户登录等示例进行说明。

哈希与加密

本文档是 October CMS 的哈希与加密配置指南。它涵盖了生成并设置安全的应用程序密钥以保护所有加密数据,以及利用 Bcrypt 算法安全存储用户密码的最佳实践,确保系统数据安全。

辅助函数

概览 October CMS 提供的辅助 PHP 函数,包括数组操作等实用工具,供插件和应用程序开发使用。

表单与HTML处理

本 October CMS 文档详细讲解如何利用其内置的门面与 Twig 标签处理 HTML 表单。内容涵盖表单的创建、方法设置、文件上传、关联后台处理以及 AJAX 表单的实现。

HTTP 客户端

介绍 Laravel HTTP 客户端的用法,涵盖发起 GET/POST 等各类请求、处理响应对象,并提供快速检查请求内容的技巧。

日志

这份文档详细介绍了OctoberCMS中的日志系统。它涵盖了日志文件的存储位置、通过门面(Facade)和辅助函数写入日志的方法、RFC 5424定义的八个日志级别、如何添加上下文信息,以及数据库日志记录的细节和注意事项。

解析器

本文档详细介绍了 October CMS 如何通过多种解析器处理标记、模板和配置,以简化开发流程。重点阐述了 Markdown 解析器,包括其 GitHub 风格语法、如何将 Markdown 内容渲染为 HTML(无论是通过后端方法还是前端过滤器),以及 Markdown 与 HTML 结合使用的规则和注意事项。

队列配置

本文档介绍如何配置和使用队列来异步处理耗时任务,如发送电子邮件,以提升应用程序的Web请求响应速度。内容涵盖队列驱动程序(如数据库、Redis、SQS)的连接配置、先决条件及基本作业推送方法。

请求与输入

本文档详细介绍了在October CMS中如何访问和处理HTTP请求中的用户输入,包括获取各种输入值、处理数组及JSON输入。同时,也涵盖了Cookie的管理,如加密、签名、获取、设置以及排队等操作,确保应用程序安全有效地处理请求数据。

图像调整器

学习如何在October CMS中使用内置的图像调整器。文档涵盖调整磁盘或上传图像的大小,设置尺寸、调整参数及保存操作。

定制响应

本文档详细介绍了在Web应用中生成和定制HTTP响应的方法。它涵盖了从CMS方法、AJAX处理器和路由返回基本字符串响应。此外,还阐述了如何利用响应对象创建健壮的自定义响应,包括附加HTTP头部、Cookies以及生成XML等特定响应类型。

Session

讲解October CMS会话管理,涵盖HTTP应用的用户数据存储、多驱动配置(如数据库、缓存、Cookie)及数据存取API。

站点管理

本文档详细阐述了 October CMS 的站点管理器。它介绍了如何配置和管理多站点功能,包括检查启用状态、根据不同场景检索站点实例(如主站点、前端主题和管理面板站点),以及通过ID、区域设置查找和列出所有或已启用的站点。

存储

October CMS存储系统概览,基于Laravel和Flysystem,提供统一的文件系统抽象层。文档详细介绍了存储配置、本地驱动器及Amazon S3驱动器的使用与管理。

验证器

本文档详细阐述了数据验证器类及其在处理用户提交表单数据时的应用。它解释了如何使用验证器确保数据的有效性,并提供了所有可用的验证规则的完整列表,涵盖了基本类型、日期、数字、字符串、文件、数据库存在性等多种验证场景。

文件设置

本技术文档详细介绍了在插件化系统中管理文件设置的方法。内容涵盖配置文件结构、定义返回数组的 PHP 配置文件、使用 Facade 访问配置值,以及文件名对配置键名的影响。文档还提及设置可被环境变量或应用程序文件覆盖。

模型设置

本文档详细介绍了插件如何通过模型实现数据库驱动的设置管理。它涵盖了设置值的数据库存储、后端界面配置、设置模型类的定义,以及利用模型创建后端设置表单的流程和目录结构。

插件设置

本文档介绍插件配置系统,提供基于文件和基于模型两种主要配置方式。基于文件的配置无用户界面,适用于策略等;基于模型的配置可选用户界面,数据存储于数据库,并支持注册到管理后台的专用设置区域,以提升用户体验。文档详述了两种方法的特点及设置页面注册流程。

AJAX框架

定义和管理后端面板AJAX处理程序,涵盖控制器、部件和行为中的AJAX方法实现,请求触发及响应处理。

行为

本文档详细介绍了“行为”机制,它是一种替代PHP原生特性(trait)的增强功能。行为允许类动态扩展私有特性,支持独立的构造函数、私有方法以及安全的命名冲突处理。文档还涵盖了行为的继承、构造函数扩展、软定义以及动态实现方法,旨在提供更灵活、强大的代码复用和扩展能力。

后端控制器

介绍October CMS后端控制器的开发与配置。文档阐述了控制器如何实现MVC模式,指导开发者创建控制器PHP脚本、配置行为,并详细说明视图和配置文件的组织方式及目录结构示例,帮助用户理解和构建October CMS的后端功能。

异常处理

本文档详细介绍了应用程序框架中常见的多种异常类型,包括应用程序、系统、未找到、验证和AJAX异常,阐述了它们的用途、行为及框架处理机制。

插件本地化

本文描述了插件的后端本地化指南。它指导开发者通过在插件`lang`子目录中放置JSON语言文件,实现后端面板界面、菜单和表单标签的翻译。文档还涵盖了活动语言配置、用户偏好设置及PHP中的语言管理方法,强调JSON是首选本地化方式。

模型

本文档详细介绍了 October CMS 中的模型(Model),它基于 Laravel Eloquent 实现 Active Record 模式,用于优雅地操作数据库。内容涵盖模型的概念、与数据库表的交互方式、文件结构、配置目录以及如何定义模型。

插件

本文旨在介绍和指导插件开发。它详细阐述了插件的定义、注册机制、可实现的功能(如数据库操作、CMS组件、用户权限、后端UI扩展等),并提供了标准的插件目录结构,帮助开发者扩展系统功能。

路由

本文档详细阐述了一个使用 Laravel 路由器服务的系统中,路由的定义与管理。内容涵盖后端控制器、CMS 页面以及插件自定义路由的实现方式,并介绍如何通过门面生成 URL。

任务调度

该文档介绍如何使用命令调度器,在应用程序内部流畅定义和管理定时任务。它通过统一的调度配置,取代了繁琐的传统Cron条目,简化了任务管理,支持调度闭包、控制台和操作系统命令。

发送邮件

介绍如何在 October CMS 中发送邮件。内容涵盖使用邮件视图和模板构建邮件内容,支持 Twig 和 Markdown。文档详细说明了通过后端面板管理邮件模板和布局,以及通过代码发送邮件的流程。

单元测试

本文档详细介绍了在 October CMS 中为插件进行单元测试的方法。内容涵盖了如何创建 phpunit.xml 配置文件、使用 Artisan 命令生成测试类、遵循测试文件命名规范,以及在测试环境中管理插件的注册与启动。

视图与局部文件

本文档详细阐述了在插件架构下,视图与局部文件的组织结构及渲染方式。内容涵盖局部文件命名规范、渲染方法和特殊提示局部的使用。

小部件

本文档介绍了小部件,它们是具有用户界面和后端控制器的可复用控件,负责数据准备和处理AJAX请求。文档阐明了小部件的通用性,将其与CMS组件进行对比,并详细介绍了小部件类的文件组织结构和资产管理方式。

内容字段

本文档详细介绍了如何在插件中构建和注册自定义内容字段。内容涵盖字段定义文件的创建、类结构、目录约定、资产和局部文件的提供,以及通过命令行工具生成字段类。注册后的自定义字段可用于Tailor表单字段和蓝图,以增强系统的可扩展性。

Twig

本文详细介绍如何在基于 Twig 的 CMS 和邮件模板中,通过插件注册类创建并注册自定义 Twig 过滤器和函数。内容涵盖多种注册方法,如映射到全局函数、本地方法、静态调用或闭包,并阐述了输出转义控制及高级配置选项,旨在帮助开发者灵活扩展模板功能。

markup

app 过滤器

文档介绍了一个用于生成绝对URL的过滤器。该过滤器能将相对路径转换为包含域名和协议的完整URL,并支持静态URL转换,同时提供使用建议。

货币过滤器

这份文档介绍了 October CMS 中用于显示货币值的 Twig 货币过滤器。它涵盖了 Currency 插件的安装步骤,并详细说明了过滤器的用法及支持的选项参数,如指定目标货币或源货币。

default 过滤器

本文档介绍一个过滤器,用于在值未定义或为空时提供默认值。该过滤器在被过滤值为空或未定义时返回指定默认值,否则返回原值,旨在确保变量可能未定义时表达式的健壮性。

link过滤器

描述了一个过滤器,它根据页面查找器小部件生成指向页面的公共URL,并返回包含URL、修改时间及标题等详细信息的对象。

Markdown 过滤器

介绍了Markdown转换为HTML的多个过滤器,着重阐述了`md_safe`等安全过滤器在解析Markdown时如何通过HTML转义和危险代码清理,确保内容安全。

media 过滤器

本文档介绍如何在CMS(如October CMS)中通过媒体过滤器和PHP接口生成媒体文件URL。

page 过滤器

本文档提供了关于Web框架中页面链接创建和管理的指南。涵盖了使用过滤器生成指向指定页面或当前页面的链接,处理子目录和URL参数。此外,还介绍了从PHP访问链接、实现反向路由以及持久化URL参数的详细方法。

raw 过滤器

本文档解释了 October CMS 中输出变量的自动转义行为,以及过滤器如何标记安全值以控制转义。它提醒开发者在使用表达式内的过滤器时应注意,以确保输出安全。

resize 过滤器

本文档详细介绍了图片大小调整过滤器的使用,包括配置图片尺寸、裁剪、自定义文件名与文件扩展名,以及输出 URL 和文件路径管理。

theme 过滤器

本文档详细介绍了如何利用主题过滤器和资产合并器来管理网站资源,包括CSS和JavaScript。内容涵盖生成资产的绝对URL、组合同类型资产、启用资源压缩功能,以及使用别名引用常用文件路径,例如AJAX框架资产。

trans 过滤器

本文档阐述了使用翻译和本地化过滤器进行字符串本地化处理,涵盖参数替换、复数化函数的应用及语法。它讨论了如何利用应用程序的本地化配置,并与CMS主题和Laravel本地化功能相关联。

abort

本文档详细介绍了中止()函数的使用方法,该函数允许开发者在请求路径中修改HTTP响应代码和内容。它可用于设置自定义HTTP状态码、显示404页面、错误页面,或仅在不改变响应体的情况下设置HTTP状态头,从而灵活控制请求的响应流。

ajaxHandler

本文档介绍了`ajaxHandler()`函数,该函数用于在 Twig 环境中执行 AJAX 处理程序并准备响应对象。它详细说明了返回结果的结构,包括数据和错误属性,并提供了示例。

carbon

本技术文档详述了如何在 Twig 模板中利用 Carbon 函数和对象进行日期与时间处理。内容涵盖获取当前/自定义日期时间、应用多种格式(含 ISO)、时区自动转换、显示人性化时间差,以及用于生成缓存失效 URL 的用法,并提供了详细的日期格式速查表。

collect

描述 Twig 中 `collect()` 函数的使用,通过集合对象简化数组构建与操作,并介绍混洗、排序等常用方法。

config

文档介绍在PHP环境中,如何使用辅助函数访问配置值和环境变量,并处理默认值。同时警告,在安全模式启用时,这些函数将不可用。

dump

文档介绍了 Twig 模板中用于调试的 `dump()`、`d()` 等函数,用于检查和转储变量信息。它还涵盖了转储后终止进程的函数,并指出所有调试功能在启用安全模式时不可用。

form

本文档介绍PHP表单辅助函数,重点讲解`form_open()`。它详细说明如何生成包含CSRF保护的HTML表单,配置`method`、`url`、AJAX处理程序等选项,并支持模型绑定。

html

介绍 `html()` 前缀的PHP辅助函数,用于HTML标记处理。功能涵盖移除、限制、清理XSS及邮件混淆等,也可作为Twig过滤器使用。

pager

本文档描述一个分页处理函数,它返回包含页码和链接的对象,并能渲染默认HTML。支持通过Twig显示结果和自定义模板。

redirect

本文档详细介绍了 `重定向()` 函数的使用方法,该函数用于将响应重定向到指定的 URL 或 CMS 页面。文档涵盖了如何传递目标地址、页面参数以及设置 HTTP 重定向代码(如临时或永久重定向),默认代码为 302。

response

本文档阐述 `response()` 函数的使用,该函数用于阻止页面显示并返回 HTTP 响应。内容涵盖设置 JSON 负载、指定 HTTP 状态码及添加自定义头部,旨在帮助开发者高效构建 API 资源。

str

本文档详细介绍了PHP字符串辅助函数,用于执行大小写转换、截断、替换等常见操作,并说明其作为Twig过滤器和与PHP类的映射关系。

this.controller

本文档详细阐述了如何在应用中访问当前控制器对象,并解释了该对象的具体功能与返回结果。

this.environment

介绍了如何访问和使用当前应用环境对象,以获取当前环境配置字符串。文档通过示例演示了如何根据应用运行环境(如测试环境)显示特定信息或执行条件逻辑。

this.layout

描述布局对象的属性,包括将其文件名转换为CSS友好标识符的ID,以及布局的描述信息。

this.page

介绍网站或CMS中页面对象的各项属性,包括布局、CSS ID、标题、描述、SEO元数据、可见性和文件名,适用于PHP开发环境。

this.param

本文档旨在指导用户如何在CMS模板中访问URL参数。它演示了获取当前页面参数的方法,处理动态参数名,并指出参数将以PHP数组形式返回,提供示例方便用户理解和操作。

this.request

文档介绍了如何通过 `this.request` 访问当前 HTTP 请求对象,以获取请求方法、AJAX状态、Turbo Router (Pjax) 请求标识及其缓存状态等信息。

this.session

此文档详细介绍了会话管理器(this.session)及其API的使用方法。内容涵盖了如何访问当前会话、配置会话,以及通过 `get()`、`has()`、`存入()` (put)、`忘记()` (forget) 等方法进行会话数据的检索、检查、存储和删除,还包括清除所有会话数据的功能。

this.site

本文档详细介绍了如何访问活动站点并获取其定义。重点阐述了如何检索当前站点的区域设置,包括在指定时返回特定区域设置、未指定时返回空值,以及如何通过特定属性确保始终返回区域设置值(包括使用默认区域设置)的方法。

this.theme

本文档详细介绍主题对象及其定制对象的结构与属性,包括如何访问由主题定义的表单字段值,将主题目录名转换为CSS友好的标识符,以及获取主题配置数组。

标记

本文档提供标记的全面指南,旨在帮助用户理解其概念、作用及正确使用方法,从而有效组织或识别信息。

{% ajaxPartial %}

文档介绍基于 Twig 的 `ajaxPartial` 标签,实现 AJAX 驱动的自更新局部内容。它支持短更新语法、懒加载,并详细说明了其工作原理及应用方式。

{% cache %}

本文档详细阐述了如何使用 {% cache %} 标签实现页面或局部视图内容缓存。内容涵盖缓存键设置、过期时间配置,并重点介绍了通过嵌入版本号或数据更新时间戳等信息,实现缓存智能失效的最佳实践。同时,也提醒了缓存标签对变量作用域的影响。

{% component %}

本文档详细介绍了CMS中`{% component %}`标签的使用。它解释了如何解析和显示组件的默认内容(如default.htm局部文件),支持传递变量,并阐述了将默认标记移动到局部文件或通过主题覆盖等自定义组件的方法。

{% content %}

本文档详细介绍了CMS内容块的使用,包括渲染、变量传递、格式支持、与布局结合,以及其不支持Twig语法的限制和相关辅助函数。

{% flash %}

本文档详细介绍了如何在模板中渲染和管理 Flash 消息。它涵盖了使用标签和变量显示消息、按类型(如 success、error)过滤、以及通过 Twig 函数将 Flash 消息设置为变量以进行高级操作的方法。

{% for %}

本文档详细介绍了模板语言中 `for` 循环的使用方法。内容涵盖基本遍历、数字和字母范围迭代、处理空集合、循环内条件过滤以及访问 `loop` 变量等特殊循环信息,帮助开发者高效地进行数据循环展示。

{% if %}

该文档介绍了模板引擎中 `if` 和 `else` 标签的用法,涵盖表达式求值、空数组和变量定义的检测,以及与 PHP 类似的布尔评估规则和边缘情况。

{% macro %}

本文档详细介绍了在模板中使用宏(`{% macro %}`标签)的方法。内容涵盖宏的定义、参数传递、调用与导入(包括从本地、局部文件和系统视图导入),以及嵌套宏和上下文变量的传递机制。

{% page %}

本文档介绍CMS(内容管理系统)的模板与页面渲染机制。详细说明如何利用`{% page %}`等标签将页面内容注入布局模板,并通过占位符定义内容或原始标记,以构建和管理网站页面。

{% partial %}

介绍 Twig 标签在 CMS 中定义与渲染分区的方法。涵盖分区命名、变量传递、可组合分区及内容操作等高级用法。

{% placeholder %}

本文档详细介绍了模板引擎中的占位符标签(`{% placeholder %}`)及其多种用法。它涵盖了如何在布局和页面之间注入、替换或追加内容,处理多次调用以避免重复,设置默认占位符内容,以及使用函数检查内容是否存在。此外,还提到了将占位符用作变量的场景。

{% verbatim %}

本文档介绍如何使用特定标签标记内容为原始文本,以确保其不被解析器处理,并在浏览器中精确呈现。这对于展示类似 AngularJS 等模板语法内容,避免解析冲突非常有用。

Twig 模板语言

本文档详细介绍了 October CMS 如何扩展 Twig 模板语言。它涵盖了模板变量、标签、过滤器和函数的使用,以及如何通过这些扩展在模板中实现 CMS 功能、访问页面信息和编写逻辑,并简述了 Twig 访问 PHP 层的方式。

setup

环境与生产配置

介绍 October CMS 的配置管理,包括配置文件、环境变量(如 .env 文件)的设置与优先级,以及相关的安全实践,确保不同环境下的灵活配置。

数据库配置

本文档指南涵盖了应用程序的数据库配置,包括如何定义和管理多数据库连接。它详细介绍了SQLite的设置、读/写分离连接的配置方法,以及不同数据库系统(如MySQL/MariaDB)的特定配置,旨在帮助用户高效地管理数据访问和连接策略。

部署

本指南详细介绍了 October CMS 项目的生产环境部署方法。涵盖了使用 Composer 进行部署,以及在没有 Composer 或命令行权限受限时的官方 Deploy 插件方案,并强调了生产配置和 `auth.json` 文件的处理。

目录结构

本文档详细介绍了 October CMS 的模块化目录结构。它逐一阐述了 `app`、`bootstrap`、`config`、`plugins` 和 `storage` 等主要目录的功能和用途,帮助开发者理解其基于 Laravel 框架的应用文件组织方式。

错误与日志

文档介绍October CMS的错误与日志记录机制。内容涵盖事件日志的访问方式、错误详情的配置(debug模式在开发与生产环境下的设置),以及支持的多种日志文件模式(如单文件、每日等)。

安装

本文档详细介绍了安装 October CMS 所需的最低系统要求,包括PHP版本、扩展、支持的数据库和Web服务器,并提供安装提示。

邮件配置

本文档详细介绍了在 October CMS 中配置邮件服务的方法,包括通过管理面板或修改配置文件。它涵盖了 SMTP、Mailgun、Postmark 等多种邮件驱动程序的使用,并提供了相应的设置指南和驱动程序先决条件,帮助用户快速设置邮件发送功能。

任务调度与队列

本文档指导如何在October CMS中设置Cron调度器以运行定时任务,以及配置队列工作器来处理异步作业。同时提供在没有命令行访问权限下运行Cron任务的替代方案。

安全与性能配置

文档指导用户为 October CMS 配置 Web 服务器,通过使用公共文件夹(public folder)来提升生产环境的安全性。它解释了如何生成、配置公共文件夹以限制Web访问,并提供了自动化维护的建议,同时提到了性能优化。