Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaLexisNexis Class Reference
Inheritance diagram for tariqaLexisNexis:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 LexisNexisGetSourceDetails ($token, $sourceId)
 LexisNexisGetSource ($token, $sourceId)
 LexisNexisSourceSearch ($token, $query)
 LexisNexisSearch ($token, $query)
 LexisNexisGetDocuments ($token, $searchId, $begin=1, $end=20)
 LexisNexisGetFullDocuments ($token, $documentIds)
 LexisNexisGetFullDocument ($token, $documentId)
 LexisNexisGetAttachments ($token, $attachmentId)
 LexisNexisBrowseSources ($token, $folderId=null)
 LexisNexisGetSortKeys ($token, $searchId)

Data Fields

 $soap

Protected Member Functions

 _LexisNexisGetFullDocument ($documentId)
 _LexisNexisGetAttachments ($attachmentId)
 WSKAuthenticate ()
 WSKBrowseSources ($folderId=null)
 WSK2LN_BrowseSourcesResponse ($object, $folderId=null)

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_LexisNexisGetAttachments ( attachmentId) [protected]

Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$attachmentIdAttachment ID
Returns:
LexisNexisAttachment[]
_LexisNexisGetFullDocument ( documentId) [protected]

Retrieve specific document in full text [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$documentIdDocument ID
Returns:
LexisNexisDocument
LexisNexisBrowseSources ( token,
folderId = null 
)

Browse LexisNexis Source Folders

Parameters:
string$tokenSession Identifier
int$folderIdID of the folder to browse (if null, the root folder will be browsed) [OPTIONA]
Returns:
LexisNexisBrowseSourcesResponse
LexisNexisGetAttachments ( token,
attachmentId 
)

Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$tokenSession Identifier
string$attachmentIdAttachment ID
Returns:
LexisNexisAttachment[]
LexisNexisGetDocuments ( token,
searchId,
begin = 1,
end = 20 
)

Retrieve specific documents in SITE (preview) format

Parameters:
string$tokenSession Identifier
string$searchIdContains a unique identifier that identifies the original search.
int$beginIdentifies the first document to be returned in the response. It must be used in conjunction with end.
int$endIdentifies the last document to be returned in the response. It must be used in conjunction with begin.
Returns:
LexisNexisDocument[]
LexisNexisGetFullDocument ( token,
documentId 
)

Retrieve specific document in full text

Parameters:
string$tokenSession Identifier
string$documentIdDocument ID
Returns:
LexisNexisDocument
LexisNexisGetFullDocuments ( token,
documentIds 
)

Retrieve specific documents in full text or some other format and/or markup

Parameters:
string$tokenSession Identifier
string[]$documentIds List of Lexis Nexis document IDs
Returns:
LexisNexisDocument[]
LexisNexisGetSortKeys ( token,
searchId 
)

Get the Sort Keys available for each row of a LexisNexis SearchResult

Parameters:
string$tokenSession Identifier
string$searchIdLexisNexis Search ID
Returns:
Pair[]
LexisNexisGetSource ( token,
sourceId 
)

Gets a LexisNexis source

Parameters:
string$tokenThe token identifier
string$sourceIdThe source identifier public
Returns:
LexisNexisSource
LexisNexisGetSourceDetails ( token,
sourceId 
)

Gets the LexisNexis source details

Parameters:
string$tokenThe token identifier
string$sourceIdThe source identifier public
Returns:
string[]
LexisNexisSearch ( token,
query 
)

Search LexisNexis datawarehouse, and return a SearchID

Parameters:
string$tokenSession Identifier
LexisNexisQuery$queryThe search query
Returns:
LexisNexisSearchResult
LexisNexisSourceSearch ( token,
query 
)

Searches LexisNexis sources

Parameters:
string$tokenThe session identifier
LexisNexisSourceSearchRequest$queryThe query for searching the sources
Returns:
LexisNexisSourceSearchResponse
WSK2LN_BrowseSourcesResponse ( object,
folderId = null 
) [protected]

Converts a WSKBrowseSourcesResponse into a LexisNexisBrowseSourcesResponse

Parameters:
WSKBrowseSourcesResponse$objectResponse object
int$folderIdID of the folder currently browsed
Returns:
LexisNexisBrowseSourcesResponse
WSKAuthenticate ( ) [protected]

Establish a connection with the LexisNexis WSK and return the security token (might be cached for performance reasons)

Returns:
string WSK BinarySecurityToken
WSKBrowseSources ( folderId = null) [protected]

Get a list of available Sources

Parameters:
int$folderId[OPTIONAL]
Returns:
WSKBrowseSourcesResponse

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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