Setting

<br/> >i 本文档的最新修订日期是: > **2023-05-16** # Setting :: 读取或修改模块配置文件中的配置项。 本模块仅适用于按照《APIPHP模块开发规范》所开发的模块。 # 公共参数 * **<font color="#ff6600">`module(模块)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`默认值见方法参数`</font>: 用以指定模块名称,例如 <font color="#c7254e">`Pay`</font> 。 * **<font color="#ff6600">`name(名称)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`默认值见方法参数`</font>: 用以指定配置项的名称。 # get() ## 说明 **<font color="#0099ff"><font color="#ff6600">Setting</font> :: <font color="#ff6600">get</font> ( <kbd>传参数组</kbd> )</font>** 获取一个模块的指定配置项的值。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ## 参数 * **<font color="#ff6600">`module(模块)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 * **<font color="#ff6600">`name(名称)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 ## 返回 多类型。 根据配置项名称的不同,返回的值的类型也可能不同。 # set() ## 语法 **<font color="#0099ff"><font color="#ff6600">Setting</font> :: <font color="#ff6600">set</font> ( <kbd>传参数组</kbd> )</font>** ## 说明 修改指定的配置项,并保存至配置项文件中。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ## 参数 * **<font color="#ff6600">`module(模块)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 * **<font color="#ff6600">`name(名称)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 * **<font color="#ff6600">`value(值)`</font>** <font color="#0099ff">`(Mix)`</font> <font color="#BBBBBB">`<必须>`</font>: 用以指定配置项的值。 >w 值的数据类型必须与配置项变更前值的数据类型 <font color="#c7254e">`相同`</font> 。 ## 返回 无。 # change() ## 说明 **<font color="#0099ff"><font color="#ff6600">Setting</font> :: <font color="#ff6600">change</font> ( <kbd>传参数组</kbd> )</font>** 临时地修改指定的配置项,仅在运行时有效,配置项文件不会被改动。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ## 参数 * **<font color="#ff6600">`module(模块)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 * **<font color="#ff6600">`name(名称)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 * **<font color="#ff6600">`value(值)`</font>** <font color="#0099ff">`(Mix)`</font> <font color="#BBBBBB">`<必须>`</font>: 用以指定配置项的值。 >d 有页面被引用时,不能在此页面引用之前去修改被引用页面中使用到的新的模块的配置项。 >w 对于部分在模块加载时就已经使用了配置项的模块(比如 <font color="#c7254e">`Mysql`</font> 模块),此方法对已使用的配置项无效。 >w 值的数据类型必须与配置项变更前值的数据类型 <font color="#c7254e">`相同`</font> 。 ## 返回 无。