Abstract Class midcom_services_indexer_backend_xmltcp

Description

XMLComm implementation using a TCP/IP interface.

...

Located in /midcom/services/indexer/backend_xmltcp.php (line 28)

midcom_services_indexer_backend
   |
   --midcom_services_indexer_backend_xmltcp
Variable Summary
 midcom_services_indexer_XMLComm_ResponseParser $_response
Method Summary
 midcom_services_indexer_backend_xmltcp midcom_services_indexer_backend_xmltcp ()
 bool delete (string $RI)
 bool delete_all ()
 bool index (Array $documents)
 Array query (string $query, midcom_services_indexer_filter $filter)
 void _exec ()
Variables

The request to execute.

  • access: private
midcom_services_indexer_XMLComm_ResponseParser $_response = null (line 44)

The response received.

  • access: private
Methods
Constructor midcom_services_indexer_backend_xmltcp (line 50)

Constructor is empty at this time.

midcom_services_indexer_backend_xmltcp midcom_services_indexer_backend_xmltcp ()
delete (line 81)

Removes the document with the given resource identifier from the index.

  • return: Indicating success.
bool delete (string $RI)
  • string $RI: The resource identifier of the document that should be deleted.

Redefinition of:
midcom_services_indexer_backend::delete()
Removes the document with the given resource identifier from the index.
delete_all (line 96)

Clear the index completly.

This will drop the current index.

  • return: Indicating success.
bool delete_all ()

Redefinition of:
midcom_services_indexer_backend::delete_all()
Clear the index completly.
index (line 67)

Adds a document to the index.

Any warning will be treated as error.

Note, that $document may also be an array of documents without further changes to this backend.

  • return: Indicating success.
bool index (Array $documents)
  • Array $documents: A list of midcom_services_indexer_document objects.

Redefinition of:
midcom_services_indexer_backend::index()
Adds a document to the index.
query (line 113)

Query the index and, if set, restrict the query by a given filter.

...

  • return: An arary of documents matching the query, or false on a failure.
Array query (string $query, midcom_services_indexer_filter $filter)
  • string $query: The query, which must suite the backends query syntax.
  • midcom_services_indexer_filter $filter: An optional filter used to restrict the query. This may be null indicating no filter.

Redefinition of:
midcom_services_indexer_backend::query()
Query the index and, if set, restrict the query by a given filter.
_exec (line 132)

This private helper will create a socket connection to the indexer daemon and execute the query.

Note, that both classes call generate_error on critical errors.

void _exec ()

Inherited Methods

Inherited From midcom_services_indexer_backend

 midcom_services_indexer_backend::midcom_services_indexer_backend()
 midcom_services_indexer_backend::delete()
 midcom_services_indexer_backend::delete_all()
 midcom_services_indexer_backend::index()
 midcom_services_indexer_backend::query()

Documentation generated on Mon, 21 Nov 2005 18:12:26 +0100 by phpDocumentor 1.3.0RC3