Octobercms · 3.x
文档列表
cms
数据属性 API
本文档详细介绍数据属性API,说明如何利用它无需JavaScript即可发出AJAX请求,从而以更简洁的代码实现相同功能。它将列出并解释支持的AJAX数据属性及其具体用法。
额外功能
本页面为重定向通知,告知用户“额外功能”相关内容已迁移至文档的新章节,并引导用户前往新的位置。
AJAX处理程序
本文档详细介绍了 AJAX 事件处理程序的概念、创建和调用方法。它涵盖了如何在页面、局部、布局或 CMS 组件中定义 PHP 函数作为 AJAX 处理程序,以及如何通过数据属性或 JavaScript API 发送请求。文档还解释了处理程序的优先级、自动注册及在 Twig 局部视图中调用处理程序,旨在指导开发者高效实现页面内容的动态更新。
可观察控件
本文档详细介绍了 October CMS 中的可观察控件(MutationObserver 实现)。它解释了如何注册并管理那些能自动检测其在页面上添加或移除的 HTML 控件。通过定义控件类和使用 `data-control` 属性,开发者可以利用 `connect()` 和 `disconnect()` 方法,在 AJAX 或 Turbo Router 更新时,有效响应 DOM 变化以初始化或取消初始化控件。
CMS AJAX
本文档详细介绍了 October CMS 内置的 AJAX 框架。它涵盖了通过 JavaScript API 和数据属性 API 使用框架的方法,如何将其引入 CMS 主题,以及利用其提供的额外功能,如表单验证、加载指示器和闪存消息,以实现无需刷新页面的动态交互。
表单 API
文档介绍 October CMS 框架的 JavaScript API,阐述如何使用其方法与表单元素交互,实现 AJAX 处理。内容涵盖了目标元素、处理程序名称及特定选项等参数。
路由使用
该文档介绍了极速路由器Turbo路由,一种PJAX实现,它通过客户端自动替换页面实现单页应用性能,同时避免复杂框架。内容涵盖其工作原理、编程式访问链接、如何全局、按页面或按链接禁用PJAX,以及导航时的滚动行为管理。
更新局部
本文档介绍如何通过AJAX实现页面局部内容的动态更新。涵盖拉取更新、模板标签、数据属性/JavaScript API以及全局/自更新局部等多种方法。
集合
此文档描述了一个用于在页面上显示条目集合的组件,支持通过 `handle` 属性指定数据源和配置分页功能。它详细介绍了组件的可用属性及其用途,方便开发者在不同页面、布局或模板中集成和自定义显示。
全局组件
该文档介绍了“全局组件”,它使全局记录(如配置或数据)可用于页面、布局或局部。文档详细说明了该组件的属性、基本用法,以及如何在页面中通过别名访问和显示这些全局数据。
资源组件
介绍资源组件及其属性,用于管理和注入JavaScript、CSS等前端资源到页面,支持创建变量和添加头部。
节组件属性
文档介绍了名为“节组件”的功能组件,用于定义网站分区和支持条目管理。该组件主要在从后端面板预览内容时使用,文档详细说明了其支持的所有属性及其功能。
选站器
本文档介绍了站点选择器组件,用于多站点配置。它涵盖了组件的基本用法、如何在不同页面间切换和加载站点、以及通过全局事件处理和翻译URL参数的方法,特别是在CMS环境下与模型结合使用的场景。
文件下载
本文档详细介绍 October CMS 中的文件下载功能,涵盖前端 AJAX 触发、HTML 属性配置,以及后端处理本地文件、字符串和存储服务下载的方法。
闪现消息
闪现消息是一种便捷的通知机制,用于向用户显示请求结果或即时进度。本文档详细阐述了如何在AJAX处理器、组件或PHP部分中设置和显示闪现消息。内容涵盖消息类型过滤、重定向处理、与AJAX框架及验证功能的集成,以及加载进度提示,旨在帮助用户有效利用闪现消息提升交互体验。
加载指示器
本文档介绍了在AJAX请求期间管理加载指示器的方法,涵盖了页面顶部的自动进度条和用于防止重复提交的加载按钮。它详细说明了如何通过属性、JavaScript或CSS来配置和控制这些指示器,以提升用户体验。
AJAX模态
本文介绍如何利用AJAX框架,结合Bootstrap 5模态框组件,实现动态内容加载及加载状态显示。
分页
本文档详细介绍了 October CMS 中的分页功能,涵盖了如何从模型、Tailor 组件等源进行数据分页,处理多个分页实例,以及通过自定义标记实现灵活的分页展示。
轮询懒加载
文档介绍AJAX轮询与懒加载技术,用于实现页面内容的延迟或周期性更新。阐述了其在AJAX局部模板中的应用、通过间隔自动刷新机制,以及性能考量。
重定向
本文档详细介绍了在Web应用中实现重定向的多种方法,包括AJAX请求、表单提交、CMS页面、Twig模板以及AJAX框架和Turbo路由器的应用场景。
文件上传
这份文档详细介绍了 October CMS 中的文件上传功能。它涵盖了通过表单和 AJAX 提交文件、使用辅助函数保存文件到存储盘、处理多文件上传、验证上传文件,以及将文件直接关联到模型的方法。
表单验证
本文档介绍AJAX框架中实现表单验证的多种机制,涵盖属性验证、异常处理、内联与实时单字段验证,旨在确保用户输入有效并提供清晰的错误提示。
媒体管理器
本文档详细介绍 October CMS 内置的媒体管理器,指导用户轻松发布视频、照片等媒体资产并插入到页面和内容中。内容涵盖媒体链接、存储位置配置(支持第三方提供商如 Amazon S3),以及音频、视频播放器的自定义方法。
S3 配置
本文档指导如何在 October CMS 中配置 Amazon S3 作为媒体存储。内容涵盖 Flysystem S3 包安装、AWS 存储桶创建与权限设置,以及应用文件系统配置。
API 端点
本文档详细指导如何利用主题和 Twig 模板构建 API 端点,将 CMS 组件和数据转化为 JSON 响应,以供 Vue.js 或 React 等客户端框架调用。内容涵盖响应发送、集合构建、条件处理及 HTTP 方法检查。
多站点
此文档详细介绍了 October CMS 的多站点功能,允许用户通过单一安装管理多个网站。它涵盖了如何创建和配置站点,包括名称、主题、区域设置、时区和域名匹配等关键设置。
条目蓝图
本文档详细介绍了条目蓝图的概念及其在定义网站区域标准内容结构中的应用。它解释了内容结构和条目的多种组织方式,并列举了条目蓝图支持的各项属性,旨在帮助用户理解和配置不同类型的内容模型。
定制组件
本文档指导用户如何开发和定制可复用的软件或UI组件,以满足特定应用需求或扩展现有功能。
内容字段
本文档详细介绍了 Tailor 模块中的内容字段。它解释了内容字段的定义、配置方式及其在蓝图中的通用属性,旨在帮助用户理解并自定义 Tailor 的内容结构。
Tailor 蓝图
本文档详细介绍了 Tailor 功能。它使用户能够通过基于文件的蓝图模板,快速定义网站的内容结构(如博客、团队页面),从而跳过传统插件开发。Tailor 会自动生成后端管理界面并提供前端 CMS 组件,并进一步阐述了蓝图的目录结构和应用范围。
模型
本文档介绍了如何使用 PHP 与 Tailor CMS 的模型进行交互,特别是条目记录的模型结构及其可用属性,帮助开发者理解和操作 Tailor 中的数据。
定义导航
文档介绍了如何通过蓝图文件的 `navigation` 属性,定义和定制后端区域的导航菜单。内容包括设置菜单项的显示顺序、图标以及本地化标签,以控制内容和设置等模块的菜单行为。
子主题与锁定
本文档阐述了子主题的创建、继承与配置,通过主题锁定文件保护自定义内容,并提供了命令行工具创建子主题的指南。
组件基础
本文档概述了 October CMS 组件的基础知识,重点介绍其作为构建可扩展解决方案的关键特性。它解释了组件如何扩展网站功能,包括处理 AJAX 请求、表单回发和页面执行周期,并详细说明了如何将组件添加到页面、布局及配置其属性。
内容块
该文档详细介绍了内容块和局部文件的概念,区分它们在管理静态和动态内容上的用途,并说明HTML、Markdown等文件扩展名对内容编辑模式的影响。
数据库主题
本文档介绍数据库驱动的主题功能,旨在解决文件系统无写入权限时CMS模板修改的问题。它允许将模板更改存储在数据库中,并详细说明了启用方式(全局或单个主题)及相关导入/删除命令,但需注意资产文件不包含在内。
布局
本文档介绍布局(Layout)的概念,阐述其如何定义页面通用脚手架、复用重复内容,以及页面如何引用布局和使用局部视图共享代码。
主题本地化
本指南阐述了主题本地化(多语言支持)的实现方法,包括语言文件结构、JSON键定义、自动注册机制及在Twig模板中的使用。
页面
本文档详细介绍了 October CMS 中页面的创建与配置。它涵盖了页面模板的结构、文件位置、必需部分(如配置和Twig)、以及页面配置参数的定义和作用。
局部视图
本文档介绍局部视图(Partials)的概念,阐述其在HTML复用和AJAX内容更新中的应用。内容涵盖局部视图的文件组织、配置、如何使用Twig标签进行渲染,以及向局部视图传递变量的方法,旨在帮助开发者高效利用可复用模板。
填充主题
本文档描述了主题内容填充机制,通过种子脚本导入数据库内容、Tailor蓝图和语言文件。它详细介绍了主题内`seeds`目录的结构及其子目录(如`blueprints`、`data`),并说明了`data.yaml`文件在内容导入过程中的配置作用。
主题信息
本文档详细介绍了 October CMS 主题的设置和配置。它重点说明了 `theme.yaml` 文件的作用、结构、所需字段,以及该文件在管理主题信息和将其发布到 Marketplace 上的重要性。
代码片段
文档介绍了内容片段(Snippets)功能,它允许开发者创建可重用、可配置的内容块。这些片段可在富文本或Markdown编辑器中插入和配置,支持局部文件或组件形式,通过Twig过滤器渲染。适用于嵌入视频、地图、通用评论系统及第三方集成等多种场景,大大提升了内容管理的灵活性和效率。
主题概念
本文档提供了October CMS主题的高级概述。内容涵盖主题的配置方式、文件结构、版本控制管理,并简要介绍了构成主题的核心对象,如页面、局部、布局和内容文件。
element
可用图标
本文档详细介绍了 October CMS 中可用的图标库,包括用于管理面板的 Phosphor 图标和用于核心功能的自定义 October 图标包。它解释了每个库的用途、使用方式及其图标命名约定。
条目字段属性
此文档描述了如何配置条目字段以链接到其他条目,并详细介绍了受支持的属性,例如 `source`,用于指定相关蓝图的 UUID 或句柄名称,以实现条目间的关系引用。
混入
本文档介绍如何在蓝图中使用混入字段(Mixin Fields),包括通过蓝图句柄或UUID进行引用,并提供字段命名的最佳实践。特别强调了在Tailor蓝图系统中的应用和相关定义信息。
嵌套项字段
本技术文档详细阐述嵌套项字段的用法,指导用户创建仅从属于当前记录的嵌套数据结构。内容涵盖其支持的各项属性,如label、default等配置项的说明。
定义选项
本文详细描述了如何配置和定义选项,包括通过键值对构建选项数组、为单选列表和下拉字段添加描述、图标、图片或颜色等高级值定义,以及如何使用选项预设来请求可用选项。
过滤范围
文档介绍了过滤器范围(Filter Scopes)的定义、引用场景,列举了复选框、文本、日期等多种可用过滤器类型及其可配置属性。
复选框作用域
本文档详细介绍了作为二进制开关的复选框过滤器,用于对列表应用预设条件或查询。内容涵盖了其默认值、开启/关闭机制,以及如何通过属性(如默认选中状态和自定义SQL条件)进行配置。
日期范围
介绍日期范围筛选功能,说明如何使用日期值进行数据过滤,并提供可配置的筛选器属性(如minDate)及条件逻辑。
下拉作用域
本文档详细介绍了下拉作用域(单选筛选器)的各项属性及其功能描述。它解释了如何使用该过滤器从多个项目中进行单选筛选,为用户配置和理解此UI组件提供了指导。
组范围
本文档介绍了一种灵活的组范围过滤机制,支持通过关联数据模型或预定义的选项数组对多项数据进行筛选。它详细说明了如何配置该过滤器,并列出了如 `options` 和 `optionsMethod` 等关键属性,以便定义和管理筛选选项。
数值范围
介绍如何使用数值范围和条件逻辑进行数据筛选,并详细说明支持数值过滤的属性及其用法。
切换范围
本文档介绍了“切换范围”功能,它作为一个开关,允许用户在预定义条件或列表查询之间进行切换,支持未定、开启或关闭三种状态。文档详细描述了其可用的过滤器属性,例如用于设置默认选中状态的`default`属性。
文本筛选
介绍纯文本输入筛选功能,支持或条件逻辑,并列出可用于过滤的属性。
表单字段
本文档旨在介绍表单字段、表单UI和表单小部件的定义与分类。它详细列举了包括文本、数字、下拉菜单等多种可用的表单字段类型,并说明其在CMS主题设置、自定义内容字段和后端控制器等场景中的应用。
气泡选择器
本文档介绍了气泡选择器字段,它是一种单选列表字段,支持与下拉字段类似的选项定义方式。内容涵盖其基本功能和常用字段属性,帮助用户理解和配置此字段类型。
复选框字段
本文档详细介绍了复选框字段的渲染方式及其常用属性,包括如何配置显示标签、设置默认值以及添加注释文本,旨在帮助用户理解和有效使用复选框组件或表单字段。
复选框列表
该技术文档详细阐述了复选框列表字段。内容涵盖其功能、如何定义选项(与下拉字段类似)、支持的辅助描述(与单选字段类似),并列举了如 label、options 等核心属性及其用法。
下拉字段
介绍下拉字段的渲染方式、选项配置及支持的字段属性。
电子邮件字段
本文档详细介绍了电子邮件字段的实现与配置。它描述了字段的渲染行为(如移动端专用键盘),常用属性(标签、占位符、默认值、注释),以及如何进行服务器端验证,以确保输入格式正确。
数字字段
本文档详细介绍了数字字段的属性和行为。数字字段渲染为只接受数字输入的单行文本框,并支持设置标签、默认值、注释、最小值、最大值和步长等常用配置属性。
密码字段
本文档详细介绍了密码字段的渲染、用途和常用属性,指导如何安全地捕获密码等敏感值。
单选列表
本文档详细介绍了单选列表字段,包括其功能、选项定义方法以及常用的字段属性(如label和default)。旨在帮助用户理解和配置单选列表字段。
开关字段
该文档介绍了开关字段,一种用于渲染切换开关的表单组件。它类似于复选框,但以切换形式显示。文档详细说明了开关字段支持的属性,包括label、default和comment,并指导用户如何利用这些属性进行配置。
文本字段属性
本文档详细介绍了文本字段组件,包括其单行文本框的渲染方式以及标签、占位符、默认值等常用配置属性。
文本域属性
本文档介绍了文本区域字段(Text Area Field)及其支持的常用属性,如标题和默认值,用于配置和渲染多行文本输入框。
提示字段
该文档描述了一个用户可关闭的提示字段(UI元素),并详细列出了其支持的各种属性,如标题文本(label)和辅助文本(comment),以帮助用户理解和配置此组件。
字段局部视图
描述字段UI元素如何通过局部视图进行渲染,并列出可用的配置属性,例如局部视图文件路径。
标尺字段
该文档介绍了标尺字段UI元素,它通过渲染水平线来分隔和组织表单内容,提高界面可读性。
节标题
本文档阐述了如何配置和渲染UI界面中的“节”元素,该元素主要用于显示标题和副标题。它详细介绍了通过`label`和`comment`等字段属性来定义节的标题文本及次要描述的方法。
方框字段
本文档介绍了October CMS的Boxes插件。它详细说明了如何安装该插件,如何在Tailor后端表单中定义并使用方框编辑器进行可视化页面构建,以及如何在前端渲染其内容,实现类似前端页面构建器的功能。
代码编辑器
该文档描述了代码编辑器字段,一个用于渲染纯文本编辑器以格式化代码或标记的组件。它详细列出了该字段支持的常用属性,如标签、默认值和注释,以供用户进行配置。
拾色器属性
该文档介绍了拾色器字段,一个用于选择十六进制颜色值的渲染控件。它详细说明了拾色器字段支持的常用属性,如标签和默认值,帮助开发者理解并配置此UI组件。
货币字段
该文档介绍了 October CMS 中用于输入数字货币值的货币字段表单微件。它详细说明了该字段的功能、所需的货币插件依赖、货币设置来源,以及如何通过配置属性(如格式)来定义和显示货币输入。
数据表字段
本文档介绍数据表字段,这是一个可编辑的网格组件,用于管理多行多列信息。它解释了该字段如何与模型集成(通常存储为数组或JSON格式),并详细列出了其支持的各项属性。
日期字段属性
文档介绍日期选择器字段的渲染与配置,详细说明其常用属性及其功能。
上传字段
文档介绍了文件上传字段组件,包括如何渲染用于图片或普通文件的上传器,以及支持的各项字段属性及其描述。
Markdown字段
详细说明 Markdown 编辑器字段及其支持的常用属性,帮助用户渲染和配置 Markdown 文本编辑器。
媒体查找器
文档介绍了“媒体查找器字段”组件的功能与用法。该字段用于渲染一个界面,使用户能够从媒体管理器库中选择文件,并获取所选文件的相对路径。文档详细说明了字段的交互方式以及支持的各项属性。
嵌套表单字段
介绍嵌套表单字段的渲染与配置,包括内联或YAML定义方式,以及支持的常用字段属性。
页面查找器
本文档详细介绍了“页面查找器字段”,这是一个用于在UI中选择和链接到内部页面的表单字段。它涵盖了字段的渲染、页面选择流程、结果存储格式,以及如label和default等可配置属性。
查找器字段
本文档详细介绍记录查找器字段。它是一个用于渲染相关记录详情的字段,展开后可提供弹窗列表以便搜索和选择大量记录。该字段仅支持单数关系,文档还会列出其支持的常用属性。
关系字段
本文档详细说明了关系字段如何根据其类型(单一或多重)被渲染为下拉列表或复选框。它还介绍了关系标签的来源以及可配置的字段属性,为理解和管理数据模型中的关系字段提供了指导。
中继器字段
本文档详细介绍中继器字段,用于渲染一组重复的表单字段。它说明了如何利用关联记录或可JSON化属性来定义和配置这些字段,并列出了其支持的常用属性。
富文本字段
本文档详细介绍了富文本编辑器(WYSIWYG 字段)的渲染及其常用字段属性。它涵盖了如何显示富格式文本可视化编辑器,并列出了可用的配置选项,如`label`等。
敏感字段
文档介绍敏感字段,一种用于安全管理密码、API密钥等敏感信息的表单元素。它提供显示/隐藏切换功能,加载时以占位符隐藏真实值,并通过AJAX按需安全检索,以防止信息泄露和猜测。
标签字段属性
本文档介绍了标签列表字段这一表单小部件,详细说明了如何渲染一个用于输入标签列表的字段,并列举了该字段支持的常用属性及其功能,帮助用户配置和使用此组件。
检查器类型
本文档阐述了CMS组件中使用的检查器类型,包括其定义、识别方式以及字符串、文本、复选框、下拉菜单等多种可用类型。此外,还详细介绍了如何配置这些检查器类型的属性参数,旨在指导开发者理解和应用CMS组件的属性定义。
自动完成器
该文档介绍自动完成检查器类型,一个带自动补全功能的编辑器。内容涵盖其选项的静态与动态配置、输出数据格式(数组值),以及常用的配置属性(如title、description)及其详细说明,旨在指导用户理解和使用此组件。
复选框配置
定义了复选框检查器类型,包括其在界面中的表现、参数要求、输出格式,以及支持配置标题、描述和默认值等属性。
字典检查器
本文档介绍了“字典检查器类型”,这是一个通过简单两列表格界面创建和管理键值对的UI组件。它详细说明了该检查器类型的功能、参数、输出,以及常用的配置属性(如标题、描述、默认值),并提及了额外的验证支持。
选项配置
本文档介绍了“下拉检查器类型”,它用于从预定义选项中进行单项选择。文档详细阐述了选项列表的静态与动态配置方式,输出值格式,并列出了该类型支持的各项配置属性及其说明。
对象检查器
阐述对象检查器类型,用于定义用户可编辑的对象属性。文档说明如何配置属性结构及其UI展示,例如文本字段和下拉菜单。
对象列表器
此文档介绍对象列表检查器类型,它允许用户创建和管理具有预定义结构的多个对象。文档详细说明了如何配置对象属性、指定UI标题以及其输出格式。
多选检查器
本文档详细介绍了一种多选检查器类型。它用于从预定义选项中进行多项选择,并生成对应所选选项的数组值。文档同时说明了其配置属性,以便用户进行灵活设置。
字符串输入
本文档介绍了字符串检查器类型的功能、参数及输出。它详细阐述了如何配置和使用该单行文本输入字段,并列举了常见的属性及其描述,以指导用户进行相关配置。
串列表检查
该文档描述了字符串列表检查器类型,一个允许用户通过弹出文本区域输入字符串列表的组件。它详细介绍了输入方式、输出格式,以及可配置的各项属性,用于定义和管理字符串数组数据。
文本检查器
本文档描述了文本检查器类型,这是一种支持多行长文本输入的编辑器。它详细说明了该编辑器的参数、输出格式,以及配置文本属性时可用的常见选项,包括标题、描述和默认值。
列表列
介绍如何定义和配置列表列,涵盖各种列类型、属性及其在后端列表和关系控制器中的应用。
拾色器列
阐述颜色选择器列的功能及其颜色显示方式。
货币列
介绍 October CMS 货币插件的货币列功能,涵盖其安装与配置,通过格式、源/目标货币代码等属性实现格式化货币显示。
日期时间
本文档详细介绍了各种日期和时间列的显示和格式化方式,包括完整的日期时间、纯日期、纯时间、时间差及时间语态显示,并提供了时区转换等配置选项。
图像列
此文档描述了图像列组件及其可配置属性,包括排序、缩略图尺寸、图像调整器选项和显示数量限制,用于控制表格或列表中图像列的显示和行为。
链接列
本文档详细介绍了“链接列”的配置与使用,包括linkText、linkUrl等属性,以及页面查找器链接值的自动解析。
数字计数
本文档介绍了数字列的显示与格式化(支持PHP sprintf()规则),以及如何利用其计数模型关联记录的功能,特别是在计数关系列类型中的应用。
列分部渲染
本文档介绍如何使用分部或视图文件渲染列内容。它详细说明了视图文件路径的指定方法、默认作用域(通常是控制器),以及支持的相关配置属性。
列选项
本文档介绍可选列的配置方法。该列根据记录值与可用选项(通常来自下拉列表)的匹配情况显示内容,并详细说明了 `options` 和 `optionsMethod` 等配置属性。
汇总摘要
本文档介绍了如何配置摘要列功能,以生成简洁的文本摘要。内容涵盖移除HTML标签、按字符或字数限制摘要长度,以及自定义默认长度和结尾后缀等选项。
切换列
本文档介绍一个用于显示和管理布尔列(开/关状态)的切换列功能。它支持自定义开关文本,通过传递包含 false 和 true 标签的数组来实现。
文本列
本文档详细说明了文本列的显示方式和内容对齐特性,如默认的左对齐,帮助用户理解和配置数据展示中的文本列行为。
extend
后端导航扩展
该文档详细介绍了如何通过插件扩展和自定义后端导航菜单。内容涵盖注册顶级菜单项及子项、利用本地化字符串和用户权限、控制菜单排序,以及在后端控制器中设置导航上下文以显示子菜单。
权限系统
本技术文档详细阐述了October CMS中的权限管理系统,涵盖权限代码、角色继承与用户权限覆盖机制,以及嵌套权限结构,旨在控制用户在后端面板的访问特权。
报表小部件
本文档详细指导如何在后端系统中开发和集成自定义报表小部件。内容涵盖了小部件的注册、类定义、文件目录结构、视图渲染方法,以及如何在后端仪表板中有效利用这些小部件。
管理员用户
介绍October CMS后端用户管理系统,涵盖用户模型、角色、群组、权限、登录认证、限流及密码重置等核心功能。文档提供了用户注册、登录状态检查、查找与认证的API,以及命令行密码修改工具,旨在帮助管理员高效管理用户。
构建组件
本指南详细介绍了如何在插件中构建CMS组件,包括文件结构、注册方法、配置选项及组件类定义。
控制台命令
本文档详细介绍了如何在应用程序中构建自定义控制台命令。内容涵盖命令的创建、存储位置、类结构定义,以及如何通过签名定义必需或可选的参数和选项,并设置默认值,以便实现灵活的命令行交互。
文件附件
本文档介绍如何在模型中利用多态关联实现文件附件功能。内容涵盖附件的创建、受保护上传机制以及通过上传、本地路径或URL等多种方式添加文件。
数据库操作
本文详细介绍了在某框架中进行数据库操作的方法,包括连接、原始SQL查询、查询构建器和Active Record模式。文档涵盖了数据的增删改查等核心操作,并提及了迁移和种子填充功能,旨在帮助用户高效地管理和交互数据库。
模型集合
文档介绍了模型集合对象,它是模型返回多结果集的实例,继承基础集合并提供丰富的流畅方法,支持对模型数组进行迭代、过滤、映射和归约等高效操作。
模型操作
本文档详细介绍了如何进行模型操作,包括使用模型进行数据查询、检索单个或多个记录、添加查询约束、访问模型列值,以及如何处理结果集(如使用集合和分块处理大量数据)。
属性修改
该文档详细介绍了如何通过访问器(Accessors)和修改器(Mutators)来格式化、转换和处理模型属性。内容包括在检索或设置属性时自动加密、日期字段转换为Carbon实例以及文本转换为JSON等。通过这些方法,开发者可以灵活地控制模型数据的存取和展示逻辑。
分页
本文档介绍了如何使用框架(如查询构建器或模型)的 `paginate` 方法对数据库记录进行分页,包括自动处理页码、限制、偏移量和设置每页项数,并提供简单分页选项。
查询构建器
本文档介绍一个强大的数据库查询构建器,它提供方便流畅的接口,内置SQL注入防护。该构建器支持所有主流数据库系统,可用于安全地执行各种数据库操作,并详细说明了如何检索表中的所有记录、单行或单个值。
模型关系
此文档详细介绍了October框架中如何管理和定义数据库模型关系。它阐述了在模型类中将关系定义为属性的方法,支持多种类型,并强调了关系作为强大查询构建器的功能。文档还说明了通过函数或属性灵活访问和操作这些关系的机制。
序列化
本文档介绍了在构建JSON API时,如何将模型、关系和集合序列化为数组或JSON格式。它涵盖了基本转换方法,以及如何隐藏敏感属性和向JSON追加自定义值。
迁移
本技术文档介绍数据库迁移的用途与实现。它阐述了如何使用迁移文件和模式构建器,通过定义`up`和`down`方法来管理数据库表的创建、修改及填充,实现数据库结构的版本化管理,并涵盖命令行工具的使用。
模型特性
本文档概述了模型特性,这些特性通过应用特定 trait 为模型属性提供通用功能,包括可空、可哈希、可清除、可加密和可生成 Slug 等,以简化数据处理和行为管理。
扩展方法
本文档详细阐述了如何通过插件机制扩展 October CMS。它说明了基于 Laravel 服务提供者模式,在插件的 Plugin.php 文件中注册和实现扩展的方法,并列出了可重写的核心方法。
字段联动
文档阐述了表单字段的依赖关系管理和动态更新机制,利用AJAX实时调整字段属性与选项。它还介绍了如何基于模型数据和表单上下文过滤字段,以构建灵活、健壮的动态表单。
表单控制器
本文档介绍表单控制器行为,它简化后端表单的创建、更新和预览功能。通过配置YAML文件和关联模型,开发者可轻松为控制器添加CRUD表单管理功能。
表单部件
讲解如何在插件中创建和注册后端表单小部件,涵盖类定义、目录结构、资源(JS/CSS)和局部视图管理,旨在扩展后端表单功能。
关系控制器
本文档介绍了关系控制器行为,用于在控制器中轻松管理复杂模型关系。它详细阐述了如何通过向控制器添加定义和引用 YAML 配置文件来使用和配置此行为,以及它通常如何与表单控制器结合使用。
导入导出
该文档详细介绍了如何集成和配置一个导入导出控制器行为。它阐述了通过CSV文件进行数据导入(上传、匹配列)和数据导出(下载数据库列)的功能,以及YAML配置文件的使用。
模型导入出
本文档详细介绍了如何在PHP应用中实现数据导入导出功能。它指导用户创建并配置专用的导入导出模型,这些模型扩展特定基类以定义数据处理逻辑,并与导入导出控制器协同工作。文中还说明了模型所需实现的方法及其参数。
筛选器部件
本文档详细介绍了如何在基于插件的系统中创建和注册筛选器小部件,以扩展后端列表筛选功能。内容涵盖了小部件的注册、文件目录结构(包括局部文件和静态资源)以及用于生成小部件的命令行工具。
筛选器
本文档详细介绍了 October CMS 中数据库记录的筛选功能。它涵盖了如何为列表控制器和关系控制器配置和定义过滤器,包括过滤器作用域的设置、通过配置文件管理过滤器以及声明过滤器作用域之间的依赖关系,以实现灵活的数据筛选和动态更新。
列表行为
本文档介绍列表控制器行为,一个用于在页面中添加可排序、可搜索记录列表的控制器扩展。内容涵盖其在控制器中的实现、`$implement`和`$listConfig`属性配置,以及基于YAML的列表配置文件详情。
记录排序
文档详细说明了 October CMS 中数据库记录的排序功能。内容包括如何在列表和关联控制器中通过`structure`属性启用排序,以及利用嵌套集、简单树和可排序模型等特性实现记录的拖拽重排。
CMS 包发布
介绍如何在 October CMS 市场上发布插件或主题,涵盖作者注册、包命名规范、版本控制及Composer配置等关键步骤。
OC包集成
本指南详细介绍了将 Laravel 包集成到 October CMS 插件中的关键步骤,包括配置文件、服务提供者、别名、数据库迁移和模型的处理方法。
控制反转
本文档深入探讨了控制反转(IoC)容器,解释其如何通过依赖注入(DI)机制管理类依赖。内容涵盖了IoC容器中类型的绑定与解析,包括共享实例、接口绑定到实现以及依赖的自动注入,旨在帮助开发者构建更灵活、可维护的应用程序架构。
缓存配置
本文档详细介绍了 October CMS 的缓存配置。它涵盖了如何设置默认缓存驱动程序,如文件、数据库、Memcached 和 Redis,并讨论了不同驱动的特点、推荐用法及其前提条件,旨在帮助用户优化应用程序缓存性能。
数组集合
介绍集合类,它提供一套流畅、可链式调用的API,用于高效处理数据数组,涵盖集合创建、映射、规约及各种实用方法。
事件
本文档详细介绍了事件系统的基本概念、如何订阅和监听事件,以及注册事件监听器的常见方法与位置,旨在帮助开发者实现应用的解耦和扩展。
哈希与加密
介绍应用程序中哈希与加密的实现。涵盖安全密钥配置、Bcrypt密码哈希的创建、验证与重新哈希,以及基于OpenSSL的数据加密,旨在保障用户凭证和敏感数据的安全性与完整性。
帮助函数
介绍 October CMS 的 PHP 帮助函数集合,涵盖数组处理等常见任务,便于开发者在插件和应用中调用。
表单处理
本文档介绍 October CMS 中如何使用表单助手创建和配置各类 HTML 表单,包括常规及 AJAX 表单的打开、方法设置、文件上传和处理程序关联。
HTTP 客户端
本文档详细介绍了 Laravel 框架提供的 HTTP 客户端,旨在帮助开发者轻松地向外部服务和应用程序发送出站 HTTP 请求。内容涵盖了如何使用各种 HTTP 方法发起请求、处理返回的响应对象,以及进行基本的调试和检查。
日志
本技术文档详细介绍了 October CMS 中的日志功能,涵盖日志配置、八种日志级别、上下文信息、辅助函数及数据库日志记录。旨在指导开发者有效记录和管理应用程序的运行状态与事件。
解析器
概览 October CMS 中处理模板、标记和配置的多种解析器,重点深入讲解 Markdown 解析器的工作原理、渲染方式及与 HTML 的结合使用。
队列
本文档详细介绍了队列(Queue)的概念及其作用,旨在帮助开发者通过延迟处理耗时任务来提升应用性能。内容涵盖队列的配置、支持的多种驱动程序(如数据库、Beanstalkd、Amazon SQS、Redis)及其依赖,以及如何将作业推送到队列等基本用法。
输入处理
本文档详细阐述了在 October CMS 框架中处理用户输入和 Cookie 的方法。内容涵盖了如何访问、检索、过滤请求数据,以及管理 Cookie 的加密、获取、设置与排队机制。
图片调整
本文档介绍了如何使用 October CMS 内置的图片调整器。它详细说明了如何加载图片(无论是来自磁盘文件还是页面请求),通过 `resize` 方法指定宽度、高度及其他调整参数来改变图片尺寸,并最终保存调整后的图片。内容涵盖了基本用法和可选参数。
响应处理
本文档详细介绍了在CMS方法、AJAX处理程序和路由中处理HTTP响应的各种方式,包括返回字符串、创建自定义响应对象,以及如何附加响应头和Cookie。
会话管理
介绍 October CMS 的会话管理。涵盖会话原理、多种驱动(文件、数据库、Redis等)的配置与选择,以及如何通过 Session 门面存储和操作会话数据。
多站点管理
该文档是关于 October CMS 中多站点功能的管理与访问指南。它详细说明了如何配置、启用和禁用多站点特性,检查站点状态,以及通过多种方式检索和列出站点实例(包括主站点、前端、后台、按ID或区域设置),并阐述了站点上下文。
存储管理
本指南介绍了 October CMS 的存储管理,利用 Laravel 和 Flysystem 提供统一的文件系统抽象。它详细阐述了存储磁盘的配置方法,涵盖了本地文件系统和 Amazon S3 等驱动器,旨在帮助用户实现灵活且易于切换的文件存储解决方案。
验证
本文档详细介绍了数据验证机制,包括验证器类的使用、验证错误消息的获取以及各种常用验证规则。它适用于处理用户提交的表单数据,并提及了October CMS中内置的验证特性。
文件配置
本文档详细介绍了插件的文件配置系统,包括配置文件的结构、PHP配置脚本的定义方式,以及如何通过门面(Facade)访问和管理配置值。内容涵盖了键名约定和默认值设置,确保用户能有效地组织和使用基于文件的插件配置。
模型设置
本文档详细介绍了如何利用模型在数据库中存储插件设置,实现后端配置。它涵盖了设置模型的定义、目录结构以及如何基于模型直接创建后端设置表单,从而简化插件的数据库驱动式配置管理。
插件配置
阐述插件配置的两种主要方式:基于文件和基于模型。指导开发者如何注册和定义设置,以便有效管理插件配置。
后端 AJAX
详述CMS后端AJAX库的使用,包括在控制器和行为中定义`on`前缀的AJAX处理程序,以及如何触发请求、返回数据或渲染视图,实现后端动态交互。
行为扩展
本文档介绍了一种名为“行为”的编程概念,它类似于PHP原生Traits,但提供了更强大的功能,如独立的构造函数、私有/受保护方法、安全命名冲突处理和动态扩展。文档详细阐述了行为的定义、实现方式、构造函数扩展以及软定义等高级特性,旨在提供一种更灵活、可控的代码复用机制。
后端控制器
本文详细介绍了 October CMS 后端控制器的开发与配置。它解释了控制器如何实现 MVC 模式,并涵盖了控制器 PHP 脚本、视图文件、配置文件及其在插件目录中的标准文件结构。
异常处理
本文档概述了多种异常类型,如应用程序异常、系统异常、未找到异常、验证异常和AJAX异常,详细阐述了它们的具体用途、错误信息特点以及在不同场景下的处理机制。
本地化
介绍插件的本地化方法,通过JSON文件管理后端语言字符串,并指导语言文件结构、配置以及在PHP中进行语言设置与检查。
October 模型
本文档介绍 October CMS 中基于 Laravel Eloquent 的模型(Model)实现。内容涵盖模型结构、数据库交互、数据查询与插入、文件位置与配置定义,以及新模型的生成方法,旨在指导用户高效管理数据库数据。
插件
文档介绍了插件的定义、注册机制、核心功能(如CMS组件、权限、设置等)及目录结构,阐明了插件如何扩展和自定义系统功能。
路由
介绍插件、后端控制器及CMS页面的路由定义与管理,重点讲解Laravel路由器服务和门面的使用。
任务调度
本文档介绍命令调度器,它允许开发者在应用程序内优雅地定义和管理定时任务,取代传统的多个Cron条目。只需一个服务器Cron,即可调度自定义任务、控制台命令和操作系统命令,并提供多种频率选项,简化了任务调度管理,并将调度纳入版本控制。
发送邮件
本指南详细介绍了在 October CMS 中发送邮件的方法,包括内容构建(支持 Twig 和 Markdown),以及通过文件系统或后端面板管理邮件视图、模板和布局。
插件测试
本文档详细介绍了如何在 October CMS 中为插件进行单元测试。内容涵盖了如何使用 Artisan 命令执行测试、创建 `phpunit.xml` 文件、生成和组织测试类,以及在测试环境中注册和启动插件的机制。旨在指导开发者有效测试其插件功能。
渲染视图
该文档讲解插件化系统中视图与局部视图的渲染机制。内容包括视图目录结构、局部视图命名规则(以下划线开头)、控制器渲染局部视图及参数传递,以及后端可隐藏提示局部视图的应用。
小部件
文档详细介绍了后端小部件(Widgets)组件,包括其定义、与CMS组件的区别、YAML配置,以及类文件、资源和局部视图的目录结构,帮助开发者理解和构建可复用后端控件。
内容字段
本文档详细介绍了如何在插件中构建和注册自定义内容字段。它涵盖了字段类的定义、目录结构、通过命令行生成字段,以及如何将这些自定义字段集成到 Tailor 表单和蓝图中使用。
Twig 注册
该文档详细介绍了如何在 Twig 模板引擎中注册自定义过滤器和函数,包括映射方法、静态调用、闭包以及如何配置输出转义。
markup
绝对URL
介绍一个过滤器,用于生成相对于网站公共路径的绝对URL,包含域名和协议。该过滤器可应用于各种路径和静态URL,确保正确链接网站资源,并区分其与内部页面链接功能。
货币过滤器
本文档详细介绍了 October CMS 中用于显示和转换货币值的 Currency Twig 过滤器。它说明了如何通过安装 Currency 插件来获取和使用该过滤器,并介绍了其支持的选项参数,如指定目标货币 (to) 和起始货币 (from)。
空值过滤
该文档描述了一个过滤器,它在处理表达式中可能未定义或为空的变量时,返回第一个参数作为默认值,否则返回过滤后的值。其目的是确保数据展示的健壮性并提供默认回退机制。
链接解析
此 Twig 过滤器文档介绍了如何使用页面查找器小部件获取页面的公共 URL。它详细说明了返回的链接对象包含的属性,如 URL、修改时间及标题。
MD过滤
本文档介绍用于将Markdown转换为HTML的过滤器。它详细说明了`md_safe`过滤器,该过滤器提供安全解析,会转义大部分HTML并防御脚本;以及`md_clean`过滤器,该过滤器通过清理潜在危险代码来提供更广泛的HTML支持。
生成 URL
本文档介绍如何利用媒体过滤器和PHP接口生成媒体文件的URL地址。
页面链接
本文档详述了使用过滤器和PHP在Web系统中生成页面链接的方法。内容涵盖基于文件名和子目录的链接、获取当前页面链接、以及支持URL参数的反向路由和持久化参数处理。
输出转义
本文档详细阐述 October CMS 中输出变量的自动转义机制。它解释了过滤器如何将值标记为“安全”以阻止后续转义,并提醒用户在使用表达式内的过滤器时应特别小心,以避免潜在的安全风险。
尺寸调整
本文档介绍了图像调整大小过滤器,详细说明了如何根据配置调整图片大小并输出其 URL。它涵盖了过滤器参数、裁剪选项、自定义文件名、修改图片扩展名(包括格式转换)以及确保调整后图片唯一性的方法。
资产引用合并
详细介绍 OctoberCMS 平台的主题资产管理。涵盖使用过滤器获取资产URL、合并CSS和JavaScript文件、启用资产最小化功能,以及配置合并器别名,旨在优化前端资源加载和开发流程。
本地化
本文档详细介绍了Laravel应用中的多语言本地化功能,涵盖字符串翻译、参数替换、复数化处理以及相关过滤器的使用。
中止响应
描述了中止()函数,用于修改HTTP响应并中断成功的请求路径。它允许设置自定义HTTP状态码(如404)、显示特定错误页面,或在不改变响应内容的情况下仅设置HTTP响应头。
AJAX处理器
该文档描述了如何在 Twig 中运行 AJAX 处理器,并详细说明了响应对象的结构及其包含的数据、错误和 Flash 消息等预期属性。
Carbon 日期
本文档详细指导用户在 Twig 模板中使用 `carbon()` 函数处理日期和时间。内容涵盖 Carbon 对象的用法、时区自动转换、各种日期格式化方法(包括本地化和人性化差异显示)、生成缓存清除 URL,并提供全面的日期格式速查表,帮助开发者高效管理和展示时间信息。
集合操作
本文档详细介绍了在 Twig 中利用 `collect()` 函数及其返回的集合对象,高效地进行数组构建与操作。内容涵盖了如何方便地添加、混洗和排序数组元素,显著简化 Twig 原生数组处理的复杂性。
配置与环境
此文档指导用户如何在Laravel等PHP应用中,通过`config()`函数访问配置值和`env()`函数访问环境变量,并提醒安全模式下的限制。
变量转储
本文档详细介绍了 Twig 模板引擎中的调试方法,重点阐述了 `dump()`、`d()` 和 `dd()` 函数的用法。它涵盖了如何检查模板变量、当前上下文以及这些函数在安全模式下的可用性限制,旨在帮助开发者高效诊断和解决模板运行异常。
表单助手
介绍表单助手(form helper)的用法,涵盖 form_open() 生成 HTML 表单标签、CSRF 保护及多种配置选项,并提及 AJAX 表单功能。
HTML函数
提供用于HTML标记处理的PHP辅助函数,涵盖剥离、限制、XSS清理和邮件混淆等功能,并支持作为Twig过滤器使用。
分页器
该文档介绍了分页器函数的使用方法,包括如何处理数据、获取分页结果、渲染HTML标记以及配置模板等选项,并提及与Twig函数的结合。
重定向
此文档提供重定向函数的使用指南,说明如何将响应重定向至指定URL或CMS页面,并配置页面参数与HTTP重定向状态码(如302、301)。
response() 返回
本文档介绍如何使用 `response()` 函数构建和返回 API 响应。内容涵盖设置 JSON 有效载荷、指定 HTTP 状态码以及添加自定义请求头,旨在帮助开发者有效地创建 API 资源。
字符串函数
本文档详述了一组字符串辅助函数,用于执行各种字符串处理任务。功能包括限制字符/单词数量、查找替换、多种命名风格(如驼峰式、蛇形命名)转换、以及大小写转换等。这些函数直接映射到PHP类,并可作为Twig过滤器使用,旨在简化开发中的字符串操作。
控制器访问
本文档详细说明如何访问和操作当前控制器对象,以及它所返回的对象。
环境访问
文档介绍如何通过访问环境对象获取当前环境配置信息。它通过示例展示了如何根据当前运行环境(如测试环境)来执行条件逻辑,例如显示特定的UI元素(如横幅),以实现环境相关的行为。
布局属性
本文档阐述了如何访问当前的布局对象及其核心属性。详细介绍了布局标识符如何从文件名和文件夹名生成为CSS友好格式,以及布局描述如何通过配置定义,旨在帮助开发者理解和利用系统中的布局机制。
页面属性
这份文档详细介绍了如何通过页面对象访问当前页面及其属性。它涵盖了页面布局、自动生成的CSS友好ID、SEO元数据(标题、描述、元标题、元描述)、隐藏页面设置,以及页面文件名等核心属性,适用于基于PHP的CMS或框架。
页面参数
本文档详细介绍了如何在PHP环境中访问当前URL参数。它说明了如何获取页面参数并将其作为PHP数组返回,同时提供了当参数名是变量时使用数组语法的示例和指导。
请求对象
介绍如何使用`this.request`对象访问HTTP请求的方法、AJAX/PJAX状态及缓存等信息。
会话操作
本文档阐述会话服务API,涵盖其访问方式以及会话数据的存储、获取、检查、删除和清空操作。
站点属性
此文档描述了如何访问和定义站点、检索数据,并重点阐述了如何获取和管理应用程序的区域设置,包括处理未指定区域设置时的默认值。
主题对象
本文档解释了如何访问和使用系统中的主题对象,包括其通过主题定制定义的属性,以及内置的ID和配置属性,以管理表单字段值和样式标识符。
标记
提供标记的定义、使用方法和管理指南。
自更新局部
本文档详细介绍了 `ajaxPartial` Twig 标签。该标签用于渲染可自更新的局部内容,并支持 AJAX 处理器、简化的短更新语法。它还提供了局部懒加载功能,通过 `data-request` 属性在页面加载完成后延迟渲染内容,有效优化页面性能。
组件渲染
本文档阐述CMS中`{% component %}`标签的用法,涵盖其解析组件默认标记、传递变量的功能,并详细说明了通过局部文件和主题覆盖来自定义组件输出的两种方法。
内容标签
本文档详细介绍了如何在页面中显示CMS内容块,包括其引用方式、变量传递、渲染格式、与布局的集成,以及如何在Twig模板中处理。强调内容块不直接支持Twig语法。
闪存消息
本文档详细介绍了如何在Twig模板中显示、过滤和操作闪存消息。内容涵盖了消息类型(如success、error)、渲染方式、通过函数将闪存消息设置为变量以及如何根据类型检索消息。
循环
本文档详细介绍了在模板引擎中使用 `for` 循环的各种方法。内容涵盖了如何遍历集合(数组、对象)、访问键值、处理空集合、进行范围迭代、添加循环条件以过滤数据,以及利用内置的循环变量来获取迭代信息。
条件表达式
本文档详细介绍了模板语言中 `{% if %}` 标签的用法和表达式求值规则。它解释了如何进行条件判断、检测变量定义和空值,并阐述了与 PHP 相似的真假值判断规则,包括各种边缘情况下的布尔求值。
模板宏
讲解模板中`{% macro %}`标签的使用,包括自定义函数定义、参数、导入方式(同模板、局部、系统视图)、嵌套与上下文变量传递。
页面渲染
本文档阐述了 `{% page %}` 标签在模板系统中的作用,详细说明其如何将页面内容和原始标记渲染到布局模板。它解释了页面模板如何通过占位符注入内容,并结合 `cmstemplate` 示例展示渲染流程,帮助用户理解页面与布局的结合方式。
使用局部视图
本文档详细介绍了CMS局部视图的使用,包括如何渲染视图、传递和操作变量、构建可组合视图,以及将视图内容设置为Twig变量进行处理。
占位符
本文档详细阐述了模板系统中占位符(`{% placeholder %}`)的用法。它涵盖了如何在布局中定义动态内容区域,通过`{% content %}`标签注入内容、利用属性进行替换和确保内容单次渲染,以及设置默认内容、检查占位符是否存在和将其用作变量,从而实现灵活的页面内容管理。
原文本
介绍`{% verbatim %}`标签及其作用,说明如何将其标记的代码块作为原始文本处理,避免模板引擎解析。文档旨在指导用户在集成多种模板语法(如AngularJS)时,确保内容按预期精确渲染,防止冲突。
Twig 扩展
本指南详细介绍October CMS中Twig模板语言的扩展,包括变量、标签、过滤器和函数,以及如何利用它们访问CMS功能和底层PHP逻辑。
resources
组件管理
本文档详细介绍了 October CMS 中用于项目、插件和主题管理的各种命令行操作。涵盖了插件和主题的安装、更新、禁用、启用、移除以及项目同步和许可证设置等关键功能。
Laravel 装 Rain
本指南详细介绍了如何将现有的 Laravel 9/10 项目迁移到 October CMS v3。它通过用 October CMS 的 Rain 库替换 Laravel 的 Illuminate 包来集成其核心功能,并指导用户完成认证、模块安装和应用容器更新,同时允许保留现有数据库。
版本升级
指南涵盖 October CMS 的更新、数据库迁移命令、前沿更新配置与注意事项,并提及从 v1 和 v2 升级的关键步骤。
Sail 装 October
本指南详细介绍了如何使用 Laravel Sail 为 October CMS 搭建本地 Docker 开发环境。内容涵盖针对 macOS、Windows 和 Linux 的 Laravel Sail 安装步骤,以及如何利用 Sail 启动 Web 服务器并安装 October CMS,其中包含特定的构建 URL 和预配置的数据库设置。
setup
环境配置
本文档详细介绍了 October CMS 的配置管理机制,包括通用配置文件的存储、环境变量的使用(尤其是 `.env` 文件),以及配置值的加载顺序和环境特定配置。同时提供了重要的安全提示。
数据库配置
本文档详细介绍了应用程序的数据库配置,包括如何定义和管理多个数据库连接,以及SQLite等特定数据库的配置方法。重点讲解了如何实现数据库读写分离(即为读写操作使用不同连接),以及共享通用数据库选项的机制,旨在帮助用户高效设置和优化数据库连接。
部署
本文档指导用户如何部署 October CMS 项目。它详细介绍了在具备 Composer 和 SSH 访问权限时,使用 Composer 进行部署的步骤,包括生产配置和依赖安装。文档强调了 `auth.json` 文件对于许可证验证的重要性,并简要提及了受限 shell 环境下的插件部署方法。
CMS结构
本文详细介绍了 October CMS 的模块化目录结构,阐述了 `app`、`bootstrap`、`config`、`plugins` 和 `storage` 等关键目录的用途和内容。它解释了应用程序代码、配置、扩展和生成文件存放的位置,概述了系统的组织方式。
错误与日志
本文档详细介绍了October CMS的错误与日志处理。内容涵盖事件日志的查看方式、错误详情的配置(区分开发与生产环境),以及如何设置不同的日志文件模式(如每日日志),旨在帮助用户有效进行调试和故障排除。
CMS 安装
本技术文档提供了安装 October CMS 的详细指南,包括最低系统要求(如PHP版本、扩展、支持的数据库和Web服务器)及安装注意事项。
邮件配置
该文档详细介绍了 October CMS 中邮件服务的配置方法,包括通过管理面板和文件配置,并涵盖了 SMTP、Mailgun、Postmark 等多种邮件驱动程序的设置指南。
调度与队列
本文档介绍如何在October CMS中配置定时任务调度器(Cron作业)和队列工作器,并提供无Cron环境下的替代方案,确保后台任务正常运行。
生产配置
本文档指导如何在生产环境中配置 October CMS,主要涵盖通过公共文件夹提升安全性,以及通过禁用调试模式和启用缓存来优化应用性能,旨在改善页面加载时间。