\OCP\SearchResult

The generic result of a search

Summary

Methods
Properties
Constants
__construct()
$id
$name
$link
$type
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$id

$id : string

A unique identifier for the result, usually given as the item ID in its corresponding application.

Type

string

$name

$name : string

The name of the item returned; this will be displayed in the search results.

Type

string

$link

$link : string

URL to the application item.

Type

string

$type

$type : string

The type of search result returned; for consistency, name this the same as the class name (e.g. \OC\Search\File -> 'file') in lowercase.

Type

string

Methods

__construct()

__construct(string  $id = null, string  $name = null, string  $link = null) 

Create a new search result

Parameters

string $id

unique identifier from application: '[app_name]/[item_identifier_in_app]'

string $name

displayed text of result

string $link

URL to the result within its app