Class: Kohana_SphinxQL_Core

Source Location: /kohana/sphinxql/core.php

Class Overview [line 22]


Class for managing a set of SphinxQL_Clients

Author(s):

Version:

  • 0.1

Copyright:

Variables

Constants

Methods


Child classes:

SphinxQL_Core
Wrapper class for Kohana_SphinxQL_Core

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Class for managing a set of SphinxQL_Clients

Tags:

[ Top ]


Class Variables

static $_handles = array()

[line 26]

Tags:

  • var - A collection of SphinxQL_Clients
  • access - protected

Type: array

Overrides:

[ Top ]


Class Methods

__construct

Kohana_SphinxQL_Core __construct( [string $profile = 'default'], [ $config = null])

[line 34]

Constructor

Tags:

  • access - public

Parameters:

  • string $profile - The profile name, corresponds to the config file
  • array $config - Config settings to override defaults

[ Top ]

add_server

boolean add_server( string $name, string $server)

[line 47]

Create a new SphinxQL_Client for a server and add it to the pool of clients

Tags:

  • return - The status of the creation of the SphinxQL_Client
  • access - public

Parameters:

  • string $name - An alias for this server
  • string $server - The address and port of a server

[ Top ]

new_query

SphinxQL_Query|false new_query( )

[line 61]

Create a new SphinxQL_Query, automatically add this SphinxQL_Core as the constructor argument

Tags:

  • return - The resulting query or false on error
  • access - public

Parameters:

[ Top ]

query

array|false query( SphinxQL_Query|string $query)

[line 74]

Perform a query, given either a string or a SphinxQL_Query object Cycles through all available servers until it succeeds.

In the event that it can't find a responsive server, returns false.

Tags:

  • return - The result of the query or false
  • access - public

Parameters:

  • SphinxQL_Query|string $query - A query as a string or a SphinxQL_Query object

[ Top ]


Class Constants


Documentation generated on Sun, 11 Jul 2010 21:43:17 +0900 by phpDocumentor 1.4.3