Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions
Soap_Api_Search_Service Class Reference
Inheritance diagram for Soap_Api_Search_Service:

Public Member Functions

 __construct ($assetid=0)
 
 getFunctionList ()
 
 BasicSearch ($request)
 
 AdvancedSearch ($request)
 
 ReIndex ($request)
 

Static Public Member Functions

static getComplexElements ($func_list=Array())
 
static getComplexTypes ($func_list=Array())
 
static getSimpleRestrictedTypes ($func_list=Array())
 

Detailed Description

Definition at line 31 of file soap_api_search_service.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file soap_api_search_service.inc.

Member Function Documentation

AdvancedSearch (   $request)

Description: This operation allow advanced searching of content

Parameters
array$request_info$request information 
Array (
        'AssetTypes'        => [Asset Types in Matrix]
        'ExcludeWords'      => [Words to be excluded from the search]
        'FieldLogic'        => [Either AND or OR results between fields]
        'Limit'             => [The maximum number of results returned]
        'RootIDs'           => [Search under the specified root nodes]
        'RootLogic'         => [Either AND or OR results between rootnodes]
        'ResultFormat'      => [The final output of the web service. E.g: asset_name% - asset_created%]
    'Statuses'          => [Only search for the specified statuses],
    'SearchFields'      => [Search fields],
    'ExcludeRootNodes'  => [Whether to exclude root nodes in search result],
       )
Returns
void public

Definition at line 174 of file soap_api_search_service.inc.

BasicSearch (   $request)

Description: This operation allow basic searching of content

Parameters
array$request_info$request information 
Array (
        'AssetTypes'        => [Asset Types in Matrix]
        'Limit'             => [The maximum number of results returned]
        'RootIDs'           => [Search under the specified root nodes]
        'ResultFormat'      => [The final output of the web service. E.g: asset_name% - asset_created%]
    'Statuses'          => [Only search for the specified statuses],
    'ExcludeRootNodes'  => [Whether to exclude root nodes in search result],
       )
Returns
void public

Definition at line 84 of file soap_api_search_service.inc.

static getComplexElements (   $func_list = Array())
static

getComplexElements

Returns
array public

Definition at line 400 of file soap_api_search_service.inc.

static getComplexTypes (   $func_list = Array())
static

getComplexTypes: return all the complex types used by the API

Returns
array public

Definition at line 469 of file soap_api_search_service.inc.

getFunctionList ( )

Returns a function list of the asset let the children handle this

Returns
string private
See Also
Asset::_getName()

Definition at line 55 of file soap_api_search_service.inc.

static getSimpleRestrictedTypes (   $func_list = Array())
static

getSimpleRestrictedTypes

Returns
array public

Definition at line 531 of file soap_api_search_service.inc.

ReIndex (   $request)

Description: This operation allow reindexing of indexable components of an asset

Parameters
array$request_info$request information 
Array (
        'AssetID'           => [Asset ID of the asset to be reindexed]
        'IndexComponents'   => [asset, metadata, or all]
       )
Returns
void public

Definition at line 335 of file soap_api_search_service.inc.

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