[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/phpbb/install/ -> task_interface.php (summary)

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: 61 lines (1 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

task_interface:: (5 methods):
  get_step_count()
  is_essential()
  check_requirements()
  run()
  get_task_lang_name()


Interface: task_interface  - X-Ref

Interface for installer tasks

get_step_count()   X-Ref
Returns the number of steps the task contains

This is a helper method to provide a better progress bar for the front-end.

return: int    The number of steps that the task contains

is_essential()   X-Ref
Checks if the task is essential to install phpBB or it can be skipped

Note: Please note that all the non-essential modules have to implement check_requirements()
method.

return: bool    true if the task is essential, false otherwise

check_requirements()   X-Ref
Checks requirements for the tasks

Note: Only need to be implemented for non-essential tasks, as essential tasks
requirements should be checked in the requirements install module.

return: bool    true if the task's requirements are met

run()   X-Ref
Executes the task


get_task_lang_name()   X-Ref
Returns the language key of the name of the task

return: string



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1