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 RESTful_Server

RESTful
Extended by RESTful_Server
Located at restful.lib.php

Methods summary

public
# __construct( $uri_needle = "/" )
public
# __destruct( )
public
# free( )
public &
# getLogger( )
public
# writeTrace( $s, $header = "" )
public
# getRAW( )

get the header and content from request

get the header and content from request

public array &
# getHeaders( )

if null memvar "m_errormsg" should be checked

if null memvar "m_errormsg" should be checked

Returns

array
public string
# getContent( )

if null memvar "m_errormsg" should be checked

if null memvar "m_errormsg" should be checked

Returns

string
public array &
# getParameterFromURI( )

return uri parameters (require mod_rewrite, see also config.inc.php) - if null memvar "m_errormsg" should be checked

return uri parameters (require mod_rewrite, see also config.inc.php) - if null memvar "m_errormsg" should be checked

Returns

array
public array &
# getParameterFromGET( )

return GET parameters - if null memvar "m_errormsg" should be checked

return GET parameters - if null memvar "m_errormsg" should be checked

Returns

array
public array &
# getParameterFromPOST( )

return POST parameters - if null memvar "m_errormsg" should be checked

return POST parameters - if null memvar "m_errormsg" should be checked

Returns

array
public array
# authenticate( string $realm = 'protected RESTful web service', mixed $abortHtml = null )

request the client to authenticate and return the user and password as array, if no authentication is send by client the function return HTTP Error 401 to the client and abort the script.
To abort after checking the user and passwort use the method "unauthorized"

request the client to authenticate and return the user and password as array, if no authentication is send by client the function return HTTP Error 401 to the client and abort the script.
To abort after checking the user and passwort use the method "unauthorized"

Parameters

$realm
$abortHtml
string or html_Component

Returns

array
public
# unauthorized( string $realm = 'protected RESTful web service', mixed $abortHtml = null )

return HTTP Error 401 to the client and abort the script

return HTTP Error 401 to the client and abort the script

Parameters

$realm
$abortHtml
public string
# createAuthToken( string $salt = '', string $algo = 'sha256' )

create a hashed authentification token for the consumer to map it with a ressource owner, this token could be stored in database to authentificate following REST requests (for more see the restful.server.complex.sample.php)

create a hashed authentification token for the consumer to map it with a ressource owner, this token could be stored in database to authentificate following REST requests (for more see the restful.server.complex.sample.php)

Parameters

$salt
$algo
for more see the php function "hash_algos"

Returns

string
public static array
# createAPIKey( string $username, integer $id_user = null, $algo = 'sha256' )

create/return a secure API/consumer key and secret (could be used for the GUI on Host-Side)

create/return a secure API/consumer key and secret (could be used for the GUI on Host-Side)

Parameters

$username
$id_user
$algo

Returns

array
with key and secret
public boolean
# checkAccessToken( string $accessToken, string $authToken, string $accessTokenSecret, string $timestamp, string $nonce, string $algo = 'sha1', string & $validAccessToken = null )

check the consumer/api/app/user/access token/key is valid (for more see the restful.server.complex.sample.php)

check the consumer/api/app/user/access token/key is valid (for more see the restful.server.complex.sample.php)

Parameters

$accessToken
(hash-based message authentication code (HMAC) of the timestamp followed by the api_key and nonce encrypted by your secret)
$authToken
(also known as api key or consumer key)
$accessTokenSecret
$timestamp
UTC formated DateTime like "Thu, 26 Jul 2012 14:53:44 UTC"
$nonce
$algo
for more see the php function "hash_algos"
$validAccessToken
return the vaild access token calculated by the method

Returns

boolean
public array
# getOAuthAuthorizationHeader( )

return the OAuth 1.0 Authorization-Header as array

return the OAuth 1.0 Authorization-Header as array

Returns

array
public boolean
# checkOAuthAuthorization( string $consumer_secret, string $token_secret = '', string & $validOAuth = null )

OAuth 1.0 check consumer / token is valid for access

OAuth 1.0 check consumer / token is valid for access

Parameters

$consumer_secret
$token_secret
could be empty if only consumer authentification is required
$validOAuth
return the vaild OAuth signature calculated by the method

Returns

boolean
public boolean
# retContent( string $content, string $content_type = 'text/xml', string $chunkOverXBytes = '5M', string $chunkBandwidth = '1Mbit/s' )

send back content (to return an error you can combine it with the function "header_http_error")

send back content (to return an error you can combine it with the function "header_http_error")

Parameters

$content
$content_type
$chunkOverXBytes
$chunkBandwidth

Returns

boolean
public boolean
# retPOST( mixed $post )

send back urlencoded content

send back urlencoded content

Parameters

$post

Returns

boolean

Methods inherited from RESTful

createAccessToken(), createOAuthSignature()

Properties summary

private array $m_para_uri
# array()
private array $m_para_get
# array()
private $m_logger
# null
private string $m_content
# ""
private array $m_headers
# array()
private string $m_obj_guid
# ""
private array $m_oauth
# array()
public mixed $m_trace_delAfter

size before trace file will set to zero

size before trace file will set to zero

# "1024K"
public string $m_trace_path

path for trace file

path for trace file

# ""
public string $m_trace_file

filename of tracefile

filename of tracefile

# ""
public string $m_errormsg

error message

error message

# ""
public boolean $m_validate_headers

validate the headers of request if true and set the memvar "m_errormsg", if method "getRAW" failed

validate the headers of request if true and set the memvar "m_errormsg", if method "getRAW" failed

# true
public mixed $m_gz_level

gz compression level, possibe values 0 - 9 | auto

gz compression level, possibe values 0 - 9 | auto

# 0
public boolean $m_gz_small_data

compress small data

compress small data

# false
public string $m_gz_small_data_size

data smaller this size will nerver compressed

data smaller this size will nerver compressed

# "4K"
public string $m_trace_critical_section_id

enable critical section for write trace files

enable critical section for write trace files

# null
public string $m_trace_critical_section_path

path to share the critical section for write trace files

path to share the critical section for write trace files

# "./"
public integer $m_trace_critical_section_maxlock_ms

max lock time for zombie processes

max lock time for zombie processes

# 1000
public integer $m_trace_critical_section_sleep_ms

sleep for retry enter critical section

sleep for retry enter critical section

# 10
public boolean $m_trace_sqlite

write the trace to a SQLite file instead of a text file

write the trace to a SQLite file instead of a text file

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