diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-06-25 23:27:08 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2012-11-02 18:07:00 -0400 |
| commit | d7a626c70bdfd7aea5e10ec891230cbd2e94f862 (patch) | |
| tree | 4b62e8c534321d8402bd2bff069f0c233e8823df /phpBB/includes/extension | |
| parent | c3fb0f359ca8e39ff9c4c3ffbd9e4e899075cd57 (diff) | |
| download | forums-d7a626c70bdfd7aea5e10ec891230cbd2e94f862.tar forums-d7a626c70bdfd7aea5e10ec891230cbd2e94f862.tar.gz forums-d7a626c70bdfd7aea5e10ec891230cbd2e94f862.tar.bz2 forums-d7a626c70bdfd7aea5e10ec891230cbd2e94f862.tar.xz forums-d7a626c70bdfd7aea5e10ec891230cbd2e94f862.zip | |
[ticket/10933] Expanded prose documentation for phpbb_extension_provider.
PHPBB3-10933
Diffstat (limited to 'phpBB/includes/extension')
| -rw-r--r-- | phpBB/includes/extension/provider.php | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/phpBB/includes/extension/provider.php b/phpBB/includes/extension/provider.php index d0541fa007..45b55e5cab 100644 --- a/phpBB/includes/extension/provider.php +++ b/phpBB/includes/extension/provider.php @@ -16,7 +16,15 @@ if (!defined('IN_PHPBB')) } /** -* Provides a set of items found in extensions +* Provides a set of items found in extensions. +* +* This abstract class is essentially a wrapper around item-specific +* finding logic. It handles storing the extension manager via constructor +* for the finding logic to use to find the items, and provides an +* iterator interface over the items found by the finding logic. +* +* Items could be anything, for example template paths or cron task names. +* Derived classes completely define what the items are. * * @package extension */ @@ -45,7 +53,7 @@ abstract class phpbb_extension_provider implements IteratorAggregate } /** - * Finds template paths using the extension manager. + * Finds items using the extension manager. * * @return array List of task names */ |