@absolunet/ioc2.1.0

View on GitHub

CacheServiceProvider

The cache service provider. It offers these commands: It also uses configuration under "cache" namespace.

Extends

Members

name :string

Source:
Overrides:
Name of the service provider. Will be use for display only.

Methods

register()

Source:
Register the service provider.

boot()

Source:
Boot the service provider.

bindCacheManager()

Source:
Bind cache manager service.

createPolicies()

Source:
Create cache related policies.

loadConfig(configPath)

Source:
Inherited From:
Load configuration file from given folder path.
Parameters:
Name Type Description
configPath string The configuration folder path.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadCommands(commands)

Source:
Inherited From:
Load commands into the registrar.
Parameters:
Name Type Description
commands Array.<function()> List of all commands that must be registered.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadTranslations(translationsPath)

Source:
Inherited From:
Load translations into the translator.
Parameters:
Name Type Description
translationsPath string The translations folder path.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadViews(viewsPath, namespaceopt)

Source:
Inherited From:
Add views path in the resolver. If given, it will add the views path as a namespace.
Parameters:
Name Type Attributes Description
viewsPath string The views path.
namespace string <optional>
 The views namespace.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publish(publications, tagopt)

Source:
Inherited From:
Publish paths, with an optional tag.
Parameters:
Name Type Attributes Description
publications object.<string, string> Dictionary representing the published paths, the "from" as keys and the "to" as values.
tag string <optional>
 The tag to give to the publications.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publishAssets(staticPath, folderopt)

Source:
Inherited From:
Publish static assets from given absolute folder path. Can store assets in a subfolder of the application's public directory if needed.
Parameters:
Name Type Attributes Default Description
staticPath string The absolute assets folder path to publish.
folder string <optional>
 "" The folder to store the assets when publishing.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publishConfig(configPath)

Source:
Inherited From:
Publish configuration files from given absolute folder path.
Parameters:
Name Type Description
configPath string The absolute configuration folder path to publish.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publishMigrations(migrationsPath)

Source:
Inherited From:
Publish migration stub files from given absolute folder path. Will only accept ".stub" files.
Parameters:
Name Type Description
migrationsPath string The absolute migrations folder path to publish.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publishTranslations(translationsPath)

Source:
Inherited From:
Publish translations files from given absolute folder path.
Parameters:
Name Type Description
translationsPath string The absolute translations folder path to publish.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

publishViews(viewsPath, folderopt)

Source:
Inherited From:
Publish views files from given absolute folder path. Can store views in a subfolder of the application's views directory if needed.
Parameters:
Name Type Attributes Default Description
viewsPath string The absolute views folder path to publish.
folder string <optional>
 "" The folder to store the views when publishing.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadAndPublishConfig(configPath)

Source:
Inherited From:
Load and publish configuration files.
Parameters:
Name Type Description
configPath string The configuration folder path.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadAndPublishTranslations(translationsPath)

Source:
Inherited From:
Load and publish translations from folder path.
Parameters:
Name Type Description
translationsPath string The translations folder path.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider

loadAndPublishViews(viewsPath, namespaceopt)

Source:
Inherited From:
Load and publish views with namespace from folder path, with an optional folder destination name.
Parameters:
Name Type Attributes Description
viewsPath string The absolute views folder path.
namespace string <optional>
 The views namespace for resolver and the folder to create for publishing.
Returns:
The current service provider instance.
Type
foundation.ServiceProvider