ConfigHelper

App\Helpers\ConfigHelper

Get Configuration Value by Key

ConfigHelper::fresnsConfigByItemKey($itemKey, $langTag);

Parameter Name	Type	Required	Description
itemKey	String	required	configs->item_key
langTag	String	optional	Language tag(can be omitted), only effective for multi-language configurations. If it is a multi-language configuration and not provided, the default language value will be output.

Get Configuration Values by Key Array

ConfigHelper::fresnsConfigByItemKeys($itemKeys, $langTag);

Parameter Name	Type	Required	Description
itemKeys	Array	required	configs->item_key
langTag	String	optional	Language tag(can be omitted), only effective for multi-language configurations. If it is a multi-language configuration and not provided, the default language value will be output.

Return Example

{
    "site_name": "Fresns",
    "default_language": "en",
    "default_timezone": "+8"
}

Get Configuration Values by Tag

ConfigHelper::fresnsConfigByItemTag($itemTag, $langTag);

Parameter Name	Type	Required	Description
itemTag	String	required	configs->item_tag
langTag	String	optional	Language tag(can be omitted), only effective for multi-language configurations. If it is a multi-language configuration and not provided, the default language value will be output.

Return Example

{
    "site_name": "Fresns",
    "site_desc": "Fresns is a free and open source social network service software, a general-purpose community product designed for cross-platform, and supports flexible and diverse content forms. It conforms to the trend of the times, satisfies a variety of operating scenarios, is more open and easier to re-development.",
    "site_icon": "https://assets.fresns.com/images/icons/fresns.png",
    "site_logo": "https://assets.fresns.com/images/logos/fresns.png",
    "site_copyright": "Fresns",
    "site_copyright_years": "2021-Present",
    "default_timezone": "+8",
    "site_mode": "public"
}

Get Configuration API Value by Key

ConfigHelper::fresnsConfigApiByItemKey($itemKey, $langTag);

Parameter Name	Type	Required	Description
itemKey	String	required	configs->item_key
langTag	String	optional	Language tag(can be omitted), only effective for multi-language configurations. If it is a multi-language configuration and not provided, the default language value will be output.

Determine File Configuration Type by Key

ConfigHelper::fresnsConfigFileValueTypeByItemKey($itemKey);

Parameter Name	Type	Required	Description
itemKey	String	required	configs->item_key

Description

• ID value is the file ID: the key is a number
• URL value is the file URL: the key starts with http:// or https://

Get File Path by Key

ConfigHelper::fresnsConfigFileUrlByItemKey($itemKey);

Parameter Name	Type	Required	Description
itemKey	String	required	configs->item_key

Description

• Image output as imageConfigUrl
• Video output as videoUrl
• Audio output as audioUrl
• Document output as documentPreviewUrl

Get Length Unit by langTag

ConfigHelper::fresnsConfigLengthUnit($langTag);

Parameter Name	Type	Required	Description
langTag	String	required	Language Tag

Query the language_menus key value in the configs table and output the lengthUnits parameter for the corresponding language tag.

Get Date Format by langTag

ConfigHelper::fresnsConfigDateFormat($langTag);

Parameter Name	Type	Required	Description
langTag	String	required	Language Tag

Query the language_menus key value in the configs table and output the dateFormat parameter for the corresponding language tag.