Bitrix API

ContentManager

FinalYes

Table of Contents

Methods

__construct()  : mixed
Constructor IndexManager.
getFileContent()  : string
Returns content of file. If it is office document, then manager try to extract text from document.
getFileContentFromIndex()  : null|string
Returns file content which was stored in search index.
getFolderContent()  : string
Returns content of folder.
getObjectContent()  : string
Returns text content of object.

Methods

__construct()

Constructor IndexManager.

public __construct() : mixed

getFileContent()

Returns content of file. If it is office document, then manager try to extract text from document.

public getFileContent(File $file[, array<string|int, mixed>|null $options = null ]) : string
Parameters
$file : File

File.

$options : array<string|int, mixed>|null = null
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
string

getFileContentFromIndex()

Returns file content which was stored in search index.

public getFileContentFromIndex(File $file) : null|string
Parameters
$file : File

File.

Return values
null|string

getFolderContent()

Returns content of folder.

public getFolderContent(Folder $folder) : string

Now it is only folder name.

Parameters
$folder : Folder

Folder.

Return values
string

getObjectContent()

Returns text content of object.

public getObjectContent(BaseObject $object[, array<string|int, mixed>|null $options = null ]) : string

If object is folder, then returns only name of folder. @see getFolderContent(); If object is file, then returns content of document and name of file. @see getFileContent();

Parameters
$object : BaseObject

File or Folder.

$options : array<string|int, mixed>|null = null

Custom options.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
string

        
On this page

Search results