strings

Last updated 6 months ago

Provides strings from (potentially) multiple sources, with support for loading from multiple languages.

local strs = require("cp.strings").new():fromPlist("/Path/To/Resources/${language}.lproj/MYLocalization.strings")
local value = strs:find("en", "AKey")

This will load the file for the specified language (replacing ${language} with "en" in the path) and return the value. Note: This will load the file on each request. To have values cached, use the cp.strings module and specify a plist as a source.

Submodules

API Overview

API Documentation

Constructors

new

Signature

cp.strings.new(context) -> cp.strings

Type

Constructor

Description

Creates a new strings instance. You should add sources with the from or fromPlist methods.

Parameters

Returns

Methods

context

Signature

`cp.strings:context([context]) -> table

self` </span>

Type

Method

Description

Gets or sets a context to be set for the strings. This typically includes a language, which

Parameters

Returns

find

Signature

`cp.strings:find(key[, context[, quiet]) -> string

nil` </span>

Type

Method

Description

Searches for the specified key, caching the result when found.

Parameters

Returns

Signature

`cp.strings:findInSources(key[, context[, quiet]]) -> string

nil` </span>

Type

Method

Description

Searches directly in the sources for the specified key.

Parameters

Returns

findKeys

Signature

`cp.strings:findKeys(value[, context]) -> string

nil` </span>

Type

Method

Description

Searches for the list of keys with a matching value, in the specified language.

Parameters

Returns

Signature

`cp.strings:findKeysInSources(value[, context]) -> string

nil` </span>

Type

Method

Description

Searches directly in the sources for the specified key value pattern.

Parameters

Returns

from

Signature

cp.strings:from(source) -> cp.strings

Type

Method

Description

Adds the source to the strings sources.

Parameters

Returns

fromPlist

Signature

cp.strings:fromPlist(pathPattern) -> cp.strings

Type

Method

Description

Convenience method for adding a plist source to the strings instance.

Parameters

Returns