Class: Kohana_SphinxQL_Client

Source Location: /kohana/sphinxql/client.php

Class Overview [line 22]


Class for communicating with a sphinx server

Author(s):

Version:

  • 0.1

Copyright:

Variables

Constants

Methods


Child classes:

SphinxQL_Client
Wrapper class for Kohana_SphinxQL_Client

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Class for communicating with a sphinx server

Tags:

[ Top ]


Class Variables

$_failed =  false

[line 34]

Tags:

  • var - A flag to denote whether or not this client has tried to connect and failed
  • access - protected

Type: boolean

Overrides:

[ Top ]

$_handle =  false

[line 30]

Tags:

  • var - A reference to the mysql link that this client will be using
  • access - protected

Type: resource

Overrides:

[ Top ]

$_result =  false

[line 38]

Tags:

  • var - A reference to the mysql result returned by a query that this client has performed
  • access - protected

Type: resource

Overrides:

[ Top ]

$_server =  false

[line 26]

Tags:

  • var - The address and port of the server this client is to connect to
  • access - protected

Type: string

Overrides:

[ Top ]


Class Methods

__construct

Kohana_SphinxQL_Client __construct( string $server)

[line 45]

Constructor

Tags:

  • access - public

Parameters:

  • string $server - The address and port of a sphinx server

[ Top ]

connect

boolean connect( )

[line 55]

Used to attempt connection to the sphinx server, keeps a record of whether it failed to connect or not

Tags:

  • return - Status of the connection attempt
  • access - protected

Parameters:

[ Top ]

fetch_all

array|false fetch_all( )

[line 96]

Fetch the whole result set

Tags:

  • return - The results or an error
  • access - public

Parameters:

[ Top ]

fetch_row

array|false fetch_row( )

[line 85]

Fetch one row of the result set

Tags:

  • return - The row or an error
  • access - public

Parameters:

[ Top ]

query

SphinxQL_Client query( string $query)

[line 74]

Perform a query

Tags:

  • return - This client object
  • access - public

Parameters:

  • string $query - The query to perform

[ Top ]


Class Constants


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