Class tariqaLexisNexis

Description

Located in /Tariqa.code/tariqaLexisNexis.class.php (line 5)

Tariqa
   |
   --tariqaLexisNexis
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
LexisNexisBrowseSourcesResponse LexisNexisBrowseSources (string $token, [int $folderId = null])
LexisNexisAttachment[] LexisNexisGetAttachments (string $token, string $attachmentId)
LexisNexisDocument[] LexisNexisGetDocuments (string $token, string $searchId, [int $begin = 1], [int $end = 20])
LexisNexisDocument LexisNexisGetFullDocument (string $token, string $documentId)
LexisNexisDocument[] LexisNexisGetFullDocuments (string $token, string[] $documentIds)
Pair[] LexisNexisGetSortKeys (string $token, string $searchId)
string WSKAuthenticate ()
WSKBrowseSourcesResponse WSKBrowseSources ([int $folderId = null])
LexisNexisAttachment[] _LexisNexisGetAttachments (string $attachmentId)
Variables
array $config = null (line 10)

Configuration array

  • access: protected
boolean $soap (line 16)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 23)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
LexisNexisBrowseSources (line 495)

Browse LexisNexis Source Folders

  • access: public
LexisNexisBrowseSourcesResponse LexisNexisBrowseSources (string $token, [int $folderId = null])
  • string $token: Session Identifier
  • int $folderId: ID of the folder to browse (if null, the root folder will be browsed) [OPTIONA]
LexisNexisGetAttachments (line 363)

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

  • access: public
LexisNexisAttachment[] LexisNexisGetAttachments (string $token, string $attachmentId)
  • string $token: Session Identifier
  • string $attachmentId: Attachment ID
LexisNexisGetDocuments (line 201)

Retrieve specific documents in SITE (preview) format

  • access: public
LexisNexisDocument[] LexisNexisGetDocuments (string $token, string $searchId, [int $begin = 1], [int $end = 20])
  • string $token: Session Identifier
  • string $searchId: Contains a unique identifier that identifies the original search.
  • int $begin: Identifies the first document to be returned in the response. It must be used in conjunction with end.
  • int $end: Identifies the last document to be returned in the response. It must be used in conjunction with begin.
LexisNexisGetFullDocument (line 287)

Retrieve specific document in full text

  • access: public
LexisNexisDocument LexisNexisGetFullDocument (string $token, string $documentId)
  • string $token: Session Identifier
  • string $documentId: Document ID
LexisNexisGetFullDocuments (line 267)

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

  • access: public
LexisNexisDocument[] LexisNexisGetFullDocuments (string $token, string[] $documentIds)
  • string $token: Session Identifier
  • string[] $documentIds: List of Lexis Nexis document IDs
LexisNexisGetSortKeys (line 534)

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

  • access: public
Pair[] LexisNexisGetSortKeys (string $token, string $searchId)
  • string $token: Session Identifier
  • string $searchId: LexisNexis Search ID
LexisNexisSearch (line 98)

Search LexisNexis datawarehouse, and return a SearchID

  • access: public
LexisNexisSearchResult LexisNexisSearch (string $token, LexisNexisQuery $query)
  • string $token: Session Identifier
  • LexisNexisQuery $query: The search query
LexisNexisSourceSearch (line 34)

Searches LexisNexis sources

  • access: public
LexisNexisSourceSearchResponse LexisNexisSourceSearch (string $token, LexisNexisSourceSearchRequest $query)
WSK2LN_BrowseSourcesResponse (line 620)

Converts a WSKBrowseSourcesResponse into a LexisNexisBrowseSourcesResponse

  • access: protected
LexisNexisBrowseSourcesResponse WSK2LN_BrowseSourcesResponse (WSKBrowseSourcesResponse $object, [int $folderId = null])
WSKAuthenticate (line 421)

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

  • return: WSK BinarySecurityToken
  • access: protected
string WSKAuthenticate ()
WSKBrowseSources (line 465)

Get a list of available Sources

  • access: protected
WSKBrowseSourcesResponse WSKBrowseSources ([int $folderId = null])
  • int $folderId: [OPTIONAL]
_LexisNexisGetAttachments (line 379)

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

  • access: protected
LexisNexisAttachment[] _LexisNexisGetAttachments (string $attachmentId)
  • string $attachmentId: Attachment ID
_LexisNexisGetFullDocument (line 302)

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

  • access: protected
LexisNexisDocument _LexisNexisGetFullDocument (string $documentId)
  • string $documentId: Document ID

Documentation generated on Thu, 10 Dec 2009 15:21:48 +0100 by phpDocumentor 1.4.1