Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
repository_googledocs\googledocs_content_search Class Reference
Inheritance diagram for repository_googledocs\googledocs_content_search:
repository_googledocs\googledocs_content

Public Member Functions

 get_content_nodes (string $query, callable $isaccepted)
 Generate and return an array containing all repository node (files and folders) arrays for the existing content based on the path or search query.
 
 get_navigation ()
 Build the navigation (breadcrumb) from a given path.
 

Protected Member Functions

 get_contents (string $query)
 Returns all relevant contents based on the given path and/or search query.
 

Protected Attributes

string $path
 The current path.
 
rest $service
 The rest API object.
 
bool $sortcontent
 Whether sorting should be applied to the fetched content.
 

Member Function Documentation

◆ get_content_nodes()

repository_googledocs\googledocs_content::get_content_nodes ( string $query,
callable $isaccepted )
inherited

Generate and return an array containing all repository node (files and folders) arrays for the existing content based on the path or search query.

Parameters
string$queryThe search query
callable$isacceptedThe callback function which determines whether a given file should be displayed or filtered based on the existing file restrictions
Return values
arrayThe array containing the repository content node arrays

◆ get_contents()

repository_googledocs\googledocs_content_search::get_contents ( string $query)
protected

Returns all relevant contents based on the given path and/or search query.

The method fetches all content (files) through an API call that matches a given search criteria.

Parameters
string$queryThe search query
Return values
arrayThe array containing the contents

Reimplemented from repository_googledocs\googledocs_content.

◆ get_navigation()

repository_googledocs\googledocs_content::get_navigation ( )
inherited

Build the navigation (breadcrumb) from a given path.

Return values
arrayArray containing name and path of each navigation node

The documentation for this class was generated from the following file: