Nextcloud PHP API (master)

IProfile

This interface store the results of the profiling of one request. You can get the saved profiles from the @see IProfiler.

<?php
$profiler = \OC::$server->get(IProfiler::class);
$profiles = $profiler->find('/settings/users', 10);

This interface is meant to be used directly and not extended.

Tags
since
24.0.0

Table of Contents

Methods

addChild()  : void
Add the child profile
addCollector()  : mixed
Add a data collector to the profile
getChildren()  : array<string|int, IProfile>
Get the profile's children
getCollector()  : IDataCollector|null
Get a data collector by name
getCollectors()  : array<string|int, IDataCollector>
Get all the data collectors
getMethod()  : string|null
Get the method of the profile
getParent()  : IProfile|null
Get the parent profile to this profile
getParentToken()  : string|null
Get the parent token to this profile
getStatusCode()  : int|null
Get the status code of the profile
getTime()  : int|null
Get the time of the profile
getToken()  : string
Get the token of the profile
getUrl()  : string|null
Get the url of the profile
setChildren()  : void
Set the profile's children
setCollectors()  : void
Set all the data collectors
setMethod()  : void
Set the method of the profile
setParent()  : void
Set the parent profile to this profile
setStatusCode()  : void
Set the status code of the profile
setTime()  : void
Set the time of the profile
setToken()  : void
Set the token of the profile
setUrl()  : void
Set the url of the profile

Methods

addChild()

Add the child profile

public addChild(IProfile $profile) : void
Parameters
$profile : IProfile
Tags
since
24.0.0

getChildren()

Get the profile's children

public getChildren() : array<string|int, IProfile>
Tags
since
24.0.0
Return values
array<string|int, IProfile>

getCollector()

Get a data collector by name

public getCollector(string $collectorName) : IDataCollector|null
Parameters
$collectorName : string
Tags
since
24.0.0
Return values
IDataCollector|null

getMethod()

Get the method of the profile

public getMethod() : string|null
Tags
since
24.0.0
Return values
string|null

getParent()

Get the parent profile to this profile

public getParent() : IProfile|null
Tags
since
24.0.0
Return values
IProfile|null

getParentToken()

Get the parent token to this profile

public getParentToken() : string|null
Tags
since
24.0.0
Return values
string|null

getStatusCode()

Get the status code of the profile

public getStatusCode() : int|null
Tags
since
24.0.0
Return values
int|null

getTime()

Get the time of the profile

public getTime() : int|null
Tags
since
24.0.0
Return values
int|null

getToken()

Get the token of the profile

public getToken() : string
Tags
since
24.0.0
Return values
string

getUrl()

Get the url of the profile

public getUrl() : string|null
Tags
since
24.0.0
Return values
string|null

setChildren()

Set the profile's children

public setChildren(array<string|int, IProfile$children) : void
Parameters
$children : array<string|int, IProfile>
Tags
since
24.0.0

setCollectors()

Set all the data collectors

public setCollectors(array<string|int, IDataCollector$collectors) : void
Parameters
$collectors : array<string|int, IDataCollector>
Tags
since
24.0.0

setMethod()

Set the method of the profile

public setMethod(string $method) : void
Parameters
$method : string
Tags
since
24.0.0

setParent()

Set the parent profile to this profile

public setParent(IProfile|null $parent) : void
Parameters
$parent : IProfile|null
Tags
since
24.0.0

setStatusCode()

Set the status code of the profile

public setStatusCode(int $statusCode) : void
Parameters
$statusCode : int
Tags
since
24.0.0

setTime()

Set the time of the profile

public setTime(int $time) : void
Parameters
$time : int
Tags
since
24.0.0

setToken()

Set the token of the profile

public setToken(string $token) : void
Parameters
$token : string
Tags
since
24.0.0

setUrl()

Set the url of the profile

public setUrl(string $url) : void
Parameters
$url : string
Tags
since
24.0.0

        
On this page

Search results