Nextcloud PHP API (master)

ISetupCheckManager

Tags
since
28.0.0

Table of Contents

Methods

runAll()  : array<string, array<string, SetupResult>>
Run all setup checks and return the results.
runByCategory()  : array<string, array<string, SetupResult>>
Run all tests from one specific category and return the results.
runByClass()  : array<string, array<string, SetupResult>>
Run all tests from one specific class and return the results.

Methods

runAll()

Run all setup checks and return the results.

public runAll([IOutput|null $output = null ]) : array<string, array<string, SetupResult>>
Parameters
$output : IOutput|null = null
  • Reports the check that is about to run as debug output, so a check that crashes or runs out of memory can be identified.
Tags
since
28.0.0
36.0.0
  • parameter $output was added
Return values
array<string, array<string, SetupResult>> —

Result of each check, first level key is category, second level key is title

runByCategory()

Run all tests from one specific category and return the results.

public runByCategory(string $filterByCategory[, IOutput|null $output = null ]) : array<string, array<string, SetupResult>>
Parameters
$filterByCategory : string
  • The id of the category to run.
$output : IOutput|null = null
  • Reports the check that is about to run as debug output, so a check that crashes or runs out of memory can be identified.
Tags
since
35.0.0
36.0.0
  • parameter $output was added
Return values
array<string, array<string, SetupResult>> —

Result of each check, first level key is category, second level key is title

runByClass()

Run all tests from one specific class and return the results.

public runByClass(string $filterByClass[, IOutput|null $output = null ]) : array<string, array<string, SetupResult>>
Parameters
$filterByClass : string
  • The class to run.
$output : IOutput|null = null
  • Reports the check that is about to run as debug output, so a check that crashes or runs out of memory can be identified.
Tags
since
35.0.0
36.0.0
  • parameter $output was added
Return values
array<string, array<string, SetupResult>> —

Result of each check, first level key is category, second level key is title

On this page

Search results