crVCL PHP Framework Version 2.9
  • Class
  • Tree
  • Todo
  • Download

Classes

  • _html_Doc
  • array2domxml
  • array2xml
  • cap_str
  • chart
  • chartline
  • config_crvcl_inc
  • Contoller
  • ContollerMain
  • ContollerPage
  • Controller
  • ControllerMain
  • ControllerPage
  • CouchDB
  • crAsync
  • crDateTime
  • CriticalSection
  • crJWT
  • crVCLSessionHandler
  • daemon
  • dictBase
  • domxml2array
  • DTA
  • DTAUS
  • DTAZV
  • ErrorHandler
  • ExceptionHandler
  • ffmpegbin
  • fsock
  • GeoIPLib
  • GoogleAnalyticsParser
  • htaccess
  • html5_Video
  • html_Anchor
  • html_Button
  • html_Calendar
  • html_Checkbox
  • html_ChkListbox
  • html_Choosebox
  • html_CKEditor
  • html_Colorbox
  • html_Combobox
  • html_Component
  • html_ComponentAMP
  • html_Datepicker
  • html_DivTable
  • html_Doc
  • html_DocAMP
  • html_Edit
  • html_Events
  • html_FlvBox
  • html_FocusEvents
  • html_FocusEventsEx
  • html_FoldingBox
  • html_Form
  • html_GroupBox
  • html_iFrame
  • html_Img
  • html_ImgAMP
  • html_InfoBox
  • html_Label
  • html_LinkLabel
  • html_List
  • html_Listbox
  • html_Marquee
  • html_Marquee2
  • html_Memo
  • html_Msgbox
  • html_OpenDialog
  • html_Optionbox
  • html_Panel
  • html_Radiobutton
  • html_Resultbar
  • html_RichText
  • html_Slider
  • html_Spinbutton
  • html_TabbedPane
  • html_TabControl
  • html_Table
  • html_tagCloud
  • html_TinyMCE
  • html_Window
  • http
  • httprequest
  • imap
  • imap_attachment
  • imap_body
  • imap_header
  • imap_msg
  • imgbar
  • Int64
  • JBridge
  • Logger
  • mail
  • multiAjaxHtmlResponse
  • mvc_module_loader
  • MySQL
  • MySQL_
  • MySQLBuilder
  • MySQLLang
  • MySQLResult
  • OpcodeCache
  • PDF
  • process_pid
  • QRCodeMinified
  • Redis
  • RESTful
  • RESTful_Client
  • RESTful_Server
  • RSS
  • rtf
  • sasl
  • sasl_basic
  • sasl_cram_md5
  • sasl_digest
  • sasl_interact
  • sasl_login
  • sasl_ntlm
  • sasl_plain
  • SepaRecord
  • SepaXML
  • SessionHandlerMemcache
  • SessionHandlerMySQL
  • SessionHandlerMySQLi
  • SessionHandlerRedis
  • shm
  • sitemap
  • SocialLib
  • sphinxAPI
  • sphinxQL
  • sphinxQLBuilder
  • sphinxResult
  • SQLiteDB
  • SQLiteDB_
  • SQLiteDBBuilder
  • SQLiteDBResult
  • template
  • TimeTrace
  • Viewer
  • whoisrequest
  • WSThread
  • XDXF_Parser
  • xml2array
  • xmlHelper
  • XMLRPC
  • XMLRPC_Client
  • XMLRPC_Server
  • zipLib

Interfaces

  • html_iComponent
  • icrVCLSessionHandler

Traits

  • html_tComponent

Functions

  • _ISO_Lang_Convert
  • acount
  • add_trailing_slash
  • addAjaxAnswerToElement
  • ajax_callback
  • ajax_request
  • ajax_setFormData2Fragment
  • ajax_setFragment2FormData
  • ajax_translate_special_char
  • Ansi2OEM
  • apache_request_headers
  • apc_opcode_priming_compiler
  • array2js_form_set
  • array2js_from_set
  • Array2strAttribute
  • array2string
  • array2UrlData
  • array_combine_values
  • array_concat
  • array_del
  • array_filelist
  • array_gcd
  • array_insert
  • array_isearch
  • array_key_existsEx
  • array_lcm
  • array_mix
  • array_remove_empty
  • array_search_inner
  • array_search_key
  • array_search_needle
  • array_trim
  • array_xunique
  • ascii_non_visible_decode
  • authcode
  • authenticate
  • average
  • bandwidth2byteInt
  • base64_encode_bin
  • bitInValue
  • bitVal2array
  • boolstr
  • boolToSetting
  • boolval
  • boolvalEx
  • breakpoint_set
  • breakpoint_stop
  • breakpoint_watch
  • browserSupportAjax
  • byte2str
  • calculate_RFC2104HMAC
  • cast_str
  • checkdnsrr
  • checkEmail
  • chrEx
  • cidr_match
  • clearscreen
  • com_create_guid
  • copyEx
  • cpu_get_usage
  • create_menu
  • createVisiblePageRank
  • CRLF_fix
  • cron_scheduling
  • crVCLProfiler
  • cursor_color
  • cursor_down
  • cursor_erase_eol
  • cursor_erase_line
  • cursor_erase_sol
  • cursor_left
  • cursor_pos
  • cursor_restore
  • cursor_right
  • cursor_save
  • cursor_unsave
  • cursor_up
  • data_uri
  • date2MySQLDate
  • date2Timestamp
  • dateFormat
  • dateToMySQLDate
  • debug_backtrace_string
  • debugbreak
  • debugOut
  • DEC2DMS
  • dec2str
  • decryptEx
  • deepCopy
  • defineEx
  • diffDays
  • diffHour
  • diffMin
  • diffSec
  • dir_exists
  • DMS2Array
  • DMS2DEC
  • dns_get_mx
  • download
  • download_authcode_url
  • download_from_authcode
  • download_iframe
  • download_popup
  • enableCORS
  • encryptEx
  • escape_js
  • EU_VAT_Validate
  • even
  • extractFileExt
  • extractFileName
  • file_get_mimetype
  • file_read
  • file_write
  • fileExist
  • filepermsEx
  • firebugOut
  • fix_https
  • fix_session_register
  • fixpath
  • font
  • free
  • ftok
  • fw_exception_error_handler
  • fw_mvc_reset_component_changed
  • fwErrorHandler
  • fwExceptionHandler
  • gc_collect_cycles_overX
  • gcd
  • get_browserEx
  • get_defined_constantsEx
  • get_file_from_url
  • get_include_contents
  • get_Post_RAW_Data
  • get_profiler_info
  • getAlexaPageRank
  • getallheadersEx
  • getallheadersSize
  • getBrowser
  • getClientLanguage
  • getCountryList
  • getEthnicList
  • getFrameworkCSS
  • getFrameworkJS
  • getGooglePageRank
  • getLanguageList
  • getMonthList
  • getOrigin
  • getOS
  • getPHP_OS
  • getPHP_Version
  • getProxyInfo
  • getQuarter
  • getRealIp
  • getScript
  • getScriptPath
  • getServer
  • getSTDIN
  • getSubdomain
  • gettickcount
  • getURL
  • getURLPath
  • getWeekdayList
  • googleCH
  • googleTranslator
  • GUID
  • guidEx
  • gzdecodeEx
  • header_cache
  • header_http_error
  • header_nocache
  • hex2rgb
  • hex2str
  • html2text
  • html_entity_decode
  • htmldecode
  • http
  • httpAuth
  • https
  • imagick_fingerprint
  • in_arrayEx
  • iniBuffer2BlockArray
  • iniRead
  • iniWrite
  • interval
  • intval32
  • is_base64_encoded
  • is_bin
  • is_crawler
  • is_date
  • is_https
  • is_IE
  • is_mobile
  • is_number
  • is_robot
  • is_spider
  • is_ssl
  • is_utf8
  • is_utf8Ex
  • is_windows
  • iso_decode
  • ISOLang2Letter3Letter
  • ISOLang3Letter2Letter
  • issetOr
  • js
  • js_getFormData
  • js_mailto
  • js_removeFormData
  • js_safeEMail
  • JSON_FixDoubleSerialization
  • JSON_FixSingleElementArray
  • lcm
  • left
  • levenshtein_ratio
  • levenshteinEx
  • linefeed_detect
  • luhnCheck
  • marquee
  • mb_str_replace
  • measure
  • mix
  • mount
  • move
  • msgbox
  • mssleep
  • mvc_ajax_event
  • mvc_alert
  • mvc_component_changed
  • mvc_confirmbox
  • mvc_event
  • mvc_flags
  • mvc_prompt
  • mysql_isDateEmpty
  • mysql_isDateSet
  • mysql_SET_isCondition
  • mysql_unix_timestamp
  • MySQLFilter
  • normalize
  • normalize_filename
  • object2array
  • OEM2Ansi
  • optimizeCSS
  • optimizeHTML
  • optimizeJS
  • ordEx
  • parse_include
  • parseCmdPara
  • parseHeaders
  • passwordStrength
  • pcntl_pid_exists
  • phpinfoEx
  • portscan
  • pp
  • pp_xml
  • preg_last_error_msg
  • print_ajax
  • print_br
  • print_chunked
  • print_d
  • print_gz
  • print_pretty
  • print_pretty_xml
  • protocol
  • pwGen
  • quoted_printable_encode
  • random
  • redirect
  • remove_tags
  • request_async
  • reset_last_modified_for_internal_http_cache
  • rgb2hex
  • rgb2hsb
  • rgb2hsv
  • right
  • runExternal
  • rval
  • ScriptProtection
  • sec2str
  • seo_code_to_text_ratio
  • seo_keyword_density
  • seo_page_informations
  • session_clean_user_cookies
  • session_commitEx
  • session_end
  • session_expires
  • session_is_started
  • session_logout
  • setAjaxAnswerToElement
  • setting_sqlite_read
  • setting_sqlite_write
  • showFrameworkError
  • shutdown_function_crVCL_FatalError
  • socket_writeEx
  • space
  • str2bin
  • str2byteInt
  • str2dec
  • str2hex
  • str2sec
  • str_del
  • str_extract
  • str_getAttributeVal
  • str_getCssValue
  • str_parse_tags
  • str_random
  • str_replace_bin
  • str_trim_len
  • strAttribute2Array
  • strax
  • strcut
  • strcut_bin
  • strftimeEx
  • strhtmlformat
  • stricut
  • stricut_bin
  • string2array
  • strip_chars
  • strip_linebreaks
  • strip_spaces
  • stripHTML
  • stripInvalidXml
  • stripos_bin
  • stripWhiteSpace
  • strlen_bin
  • strOrd
  • strpos_bin
  • strpos_next_word
  • strrcut
  • strrcut_bin
  • strricut
  • strricut_bin
  • strripos_bin
  • strrpos_bin
  • strrpos_next_word
  • strtolower_bin
  • strtonum
  • strtoupper_bin
  • strzero
  • strzerocast
  • substr_bin
  • terminal_beep
  • terminal_cols
  • terminal_lines
  • text2html
  • timestamp2MySQLDateTime
  • trim_specialchars
  • trim_text
  • umount
  • unauthorized
  • unicode_array
  • unique_key
  • unix2DosTime
  • unlink_files
  • unpack31
  • unserializeEx
  • unserializeEx_v1
  • unserializeEx_v2
  • unzip
  • urlData2Array
  • utcdate
  • utf8_encodeEx
  • utf8_fix
  • utf8_to_RTF
  • UUID
  • validateEmail
  • var_dumpEx
  • var_dumpExHTML
  • var_name
  • waitForInput
  • wordwarp_detect
  • writeTrace
  • wsthread_exception_error_handler
  • XML2JSON
  • xmlentities
  • xmlentities_decode
  • xmlentitiesEx
  • xmlGetPara
  • xmlGetVal
  • xor32
  • XSSFilter
  • zeroFill
  • zlib_compression

Class sphinxAPI

Sphinx PHP searchd client API, derived from sphinxapi.php of Andrew Aksyonoff / Sphinx Technologies Inc. (http://www.sphinxsearch.com/)

SphinxClient
Extended by sphinxAPI

Direct known subclasses

sphinxQL

Located at sphinxapi.lib.php

Methods summary

public
# __construct( boolean $useQL = false, integer $QLdriver = 0 )

Parameters

$useQL
(sphinxQL implementation require sphinx version >= 2.0.1-beta and use only methods from sphinxAPI/sphinxQL not SphinxClient)
$QLdriver
use 0 to autodetect best MySQL driver or use SphinxQL_over_* to force
public
# __destruct( )
public
# EscapeString( $string )
public
# GetLastError( )
public
# GetLastWarning( )
public integer
# getVersion( )

get the used version of the PHP Sphinx API

get the used version of the PHP Sphinx API

Returns

integer
public array
# getStatistics( )

return a array with statistics about request timings

return a array with statistics about request timings

Returns

array
public
# SetServer( mixed $host, mixed $port = null )

set the server ip/port (if you set more than one server, loadbalancing is active, to deactivate set only one server)

!!! use small values for the connection timeout if loadbalacing is active !!!

set the server ip/port (if you set more than one server, loadbalancing is active, to deactivate set only one server)

!!! use small values for the connection timeout if loadbalacing is active !!!

Parameters

$host
as string
$port
as int
public
# SetLimits( integer $offset, integer $limit = 1000, integer $max = 0, integer $cutoff = 0 )

set the offset/limit/cutoff for a search

set the offset/limit/cutoff for a search

Parameters

$offset
$limit
$max
$cutoff
public
# lbReconnectTime( mixed $time )

reconnect time after failover

reconnect time after failover

Parameters

$time
=> "2minutes" as string or 300 as int (sec.)
public
# retryTime( integer $ms )

time for retry a lost connection, or if sphinx daemon busy

time for retry a lost connection, or if sphinx daemon busy

Parameters

$ms
public boolean
# Connect( )

connect the server

connect the server

Returns

boolean
private
# cleanOldFashionQuery( & $query )
public array
# Query( mixed $query, string $index = "*", string $comment = "" )

connect to searchd server, run given search query through given indexes and return the search results

connect to searchd server, run given search query through given indexes and return the search results

Parameters

$query
string for sphinx client API / string or sphinxQLBuilder object for sphinxQL
$index
(not for QL)
$comment
(not for QL)

Returns

array
public sphinxResult
# rQuery( mixed $query, string $index = "*", string $comment = "" )

connect to searchd server, run given search query through given indexes and return the search results

connect to searchd server, run given search query through given indexes and return the search results

Parameters

$query
$index
$comment

Returns

sphinxResult
public
# SetConnectTimeout( integer $timeout_sec )

set the connection timeout

set the connection timeout

Parameters

$timeout_sec
public resource
# _Connect( )

Returns

resource

Constants summary

integer SphinxQL_over_MySQL
# 0
integer SphinxQL_over_MySQLi
# 1

Properties summary

private integer $_version
# 0
private integer $_timeout_sec
# 10
private array $_servers
# array()
private integer $_lb_reconnect_time_sec
# 60
private integer $_retry_on_connection_lost_ms
# 1000
private boolean $_sphinxQL
# false
private $_sphinxQL_mysql
# null
private string $_ql_error
# ""
private integer $_QLdriver
# 0
protected string $_sphinx_type
# 'SPH'
private array $_statistic
# array()
public integer $m_last_query_ms

return the last query execution time

return the last query execution time

# 0
public boolean $m_show_old_fashion_query_info

show a deprecated info if you use "old fashion queries" with a newer release like API version >= 4505 / search daemon >= 2.1 (this memvar will be removed in future releases)

show a deprecated info if you use "old fashion queries" with a newer release like API version >= 4505 / search daemon >= 2.1 (this memvar will be removed in future releases)

# true
public boolean $m_precheck_old_fashion_query

do a precheck before sending request for the use of "old-fashion" variables if the query is build by "sphinxQLBuilder" (this memvar will be removed in future releases)

do a precheck before sending request for the use of "old-fashion" variables if the query is build by "sphinxQLBuilder" (this memvar will be removed in future releases)

# true
crVCL PHP Framework Version 2.9 API documentation generated by ApiGen