Result

class OCP\Search\Result
The generic result of a search
Source:lib/public/Search/Result.php#34

Properties

public static property OCP\Search\Result::$id
A unique identifier for the result, usually given as the item ID in its
corresponding application.
Source:lib/public/Search/Result.php#43
Type:string
Since:7.0.0
Deprecated:20.0.0
public static property OCP\Search\Result::$name
The name of the item returned; this will be displayed in the search
results.
Source:lib/public/Search/Result.php#52
Type:string
Since:7.0.0
Deprecated:20.0.0
URL to the application item.
Source:lib/public/Search/Result.php#60
Type:string
Since:7.0.0
Deprecated:20.0.0
public static property OCP\Search\Result::$type
The type of search result returned; for consistency, name this the same
as the class name (e.g. \OC\Search\File -> ‘file’) in lowercase.
Source:lib/public/Search/Result.php#69
Type:string
Since:7.0.0
Deprecated:20.0.0

Methods

public OCP\Search\Result::__construct($id=null, $name=null, $link=null)
Create a new search result
Source:

lib/public/Search/Result.php#79
Parameters:
  • $id (string) unique identifier from application: ‘[app_name]/[item_identifier_in_app]’
  • $name (string) displayed text of result
  • $link (string) URL to the result within its app
Since:

7.0.0
Deprecated:

20.0.0