Documentation

CRM_Core_FileSearchInterface
in

Interface CRM_Core_FileSearchInterface

Table of Contents

Constants

DEFAULT_SEARCH_LIMIT  = 20
DEFAULT_SEARCH_OFFSET  = 0

Methods

search()  : array<string|int, mixed>

Constants

Methods

search()

public search(array<string|int, mixed> $query[, int $limit = self::DEFAULT_SEARCH_LIMIT ][, int $offset = self::DEFAULT_SEARCH_OFFSET ]) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

Any of the following:.

  • text: string, plain text to search for
  • parent_table: string - entity to which file is directly attached
  • parent_id: int - entity to which file is directly attached
  • xparent_table: string - business-entity to which file is attached (directly or indirectly)
  • xparent_id: int - business-entity to which file is attached (directly or indirectly)
$limit : int = self::DEFAULT_SEARCH_LIMIT
$offset : int = self::DEFAULT_SEARCH_OFFSET
Return values
array<string|int, mixed> —

each item has keys:

  • file_id: int
  • parent_table: string - entity to which file is directly attached
  • parent_id: int - entity to which file is directly attached
  • xparent_table: string - business-entity to which file is attached (directly or indirectly)
  • xparent_id: int - business-entity to which file is attached (directly or indirectly)

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results