• 홈
• Vanilla
• AddonManager

PHP 클래스 Vanilla\AddonManager

The {@link AddonManager} scans directories for addon folders and then maintains them in a catalogue. Addons can then be started which makes them available to the application. When an addon is started it can do the following: - Any classes the addon has declared are available via the {@link AddonManager::autoload()} method. - The addon can declare a class ending in "Plugin" and its events will be registered (TODO). - Any translations the addon has declared will be loaded for the currently enabled locale. 파일 보기 프로젝트 열기: vanilla/vanilla 1 사용 예제들

공개 메소드들

메소드	설명
__construct ( array $scanDirs, string $cacheDir )	Initialize a new instance of the {@link AddonManager} class.
autoload ( string $class )	Attempt to load undefined class based on the addons that are enabled.
checkDependants ( Addon $addon, boolean $throw = false ) : boolean	Check the enabled dependants of an addon.
checkRequirements ( Addon $addon, boolean $throw = false ) : boolean	Check an addon's requirements.
clearCache ( ) : boolean	Remove all of the cached files.
getCacheDir ( ) : string	Get the cacheDir.
getEnabled ( ) : array[Addon]	Get the enabled addons, sorted by priority with the highest priority first.
getEnabledTranslationPaths ( string $locale ) : array	Get the paths to the current translation files.
getTheme ( ) : Addon | null	Get the theme.
isEnabled ( string $key, string $type ) : boolean	Check whether or not an addon is enabled.
lookupAddon ( string $key ) : Addon | null	Lookup the addon with a given key.
lookupAllByType ( string $type ) : array	Get all of the addons of a certain type.
lookupAsset ( string $subpath, Addon $addon = null, boolean $mustExist = true ) : string	Lookup the path of an asset.
lookupByClassname ( string $class, boolean $searchAll = false ) : Addon | null	Lookup an addon by class name.
lookupByType ( string $key, string $type ) : null | Addon	Lookup an {@link Addon} by its type.
lookupDependants ( Addon $addon ) : array	Get all of the enabled addons that depend on a given addon.
lookupLocale ( string $key ) : null | Addon	Lookup a locale pack based on its key.
lookupRequirements ( Addon $addon, integer $filter = null ) : Returns	Get all of the requirements for an addon.
lookupTheme ( string $key ) : null | Addon	Lookup a theme based on its key.
scan ( string $type, boolean $saveCache = false ) : array	Scan the directories of all of the addons of a given type.
setCacheDir ( string $cacheDir ) : AddonManager	Set the cacheDir.
setTheme ( Addon $theme ) : AddonManager	Set the theme.
startAddon ( Addon $addon )	Start an addon and make it available.
startAddonsByKey ( array $keys, string $type ) : integer	Start one or more addons by specifying their keys.
stopAddon ( Addon $addon )	Stop an addon and make it unavailable.
stopAddonsByKey ( array $keys, string $type ) : integer	Stop one or more addons by specifying their keys.

비공개 메소드들

메소드	설명
deleteSingleIndexKey ( string $type, string $key ) : boolean	Delete an item from a single index and re-cache it.
ensureMultiCache ( )	Ensure that the addon cache has all of the addons.
filePutContents ( string $filename, mixed $data, integer $mode = 420 ) : boolean	A version of file_put_contents() that is multi-thread safe.
getSingleIndex ( string $type ) : array	Get the index for an addon type that is cached by single addon.
lookupRequirementsRecursive ( Addon $addon, array &$array )	The implementation of {@link lookupRequirements()}.
lookupSingleCachedAddon ( string $key, string $type ) : Addon | null	Lookup an addon that is cached on a per-addon basis.
saveArrayCache ( string $path, string $array )	Cache an array.
scanAddonDirs ( string $type ) : array	Get a list of addon directories for a given type.
themeSubdirs ( ) : array	Get the current theme and themes it's based on as an array.
typeUsesMultiCaching ( string $type ) : boolean	Test whether an addon type uses multi-caching.

메소드 상세