PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of wrapper.php

This file is part of the phpBB Forum Software package.

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	141 lines (3 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

wrapper:: (6 methods):
  __construct()
  is_parametrized()
  is_ready()
  get_url()
  get_html_tag()
  __call()

Class: wrapper - X-Ref

Cron task wrapper class.
Enhances cron tasks with convenience methods that work identically for all tasks.

__construct(task $task, helper $routing_helper, $phpbb_root_path, $php_ext, $template) X-Ref

Constructor.

Wraps a task $task, which must implement cron_task interface.

param: task    $task                The cron task to wrap.
param: helper    $routing_helper        Routing helper for route generation
param: string    $phpbb_root_path    Relative path to phpBB root
param: string    $php_ext            PHP file extension
param: \phpbb\template\template    $template

is_parametrized() X-Ref

Returns whether the wrapped task is parametrised.

Parametrized tasks accept parameters during initialization and must
normally be scheduled with parameters.

return: bool Whether or not this task is parametrized.

is_ready() X-Ref

Returns whether the wrapped task is ready to run.

A task is ready to run when it is runnable according to current configuration
and enough time has passed since it was last run.

return: bool Whether the wrapped task is ready to run.

get_url() X-Ref

Returns a url through which this task may be invoked via web.

When system cron is not in use, running a cron task is accomplished
by outputting an image with the url returned by this function as
source.

return: string URL through which this task may be invoked.

get_html_tag() X-Ref

Returns HTML for an invisible `img` tag that can be displayed on page
load to trigger a request to the relevant cron task endpoint.

return: string HTML to render to trigger cron task

__call($name, $args) X-Ref

Forwards all other method calls to the wrapped task implementation.

return: mixed

PHP Cross Reference of phpBB-3.3.14-deutsch

/phpbb/cron/task/ -> wrapper.php (summary)

Defines 1 class