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 ControllerMain

super class for the representation of the viewer

Controller
Extended by ControllerMain

Direct known subclasses

ContollerMain, Viewer

Abstract
Located at mvc.lib.php

Methods summary

public
# __construct( $path_pages = "./" )

Overrides

Controller::__construct
public string
# getPagePath( )

return the page path of the controller

return the page path of the controller

Returns

string
public
# set404( string $page )

for page not found

for page not found

Parameters

$page
public
# set405( string $page )

method not found

method not found

Parameters

$page
public
# set501( string $page )

class not found

class not found

Parameters

$page
private
# mapRequestURL( )
public
# addPermaLink( string $url_needle, string $mvc_page, string $mvc_method, array $mapping )

add a permalink / url mapping to the viewer (used for SEO optimization, require mod_rewrite)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green


$this->addPermaLink('/p/', '', 'show', array('mvc_page'));
// map a url "http://mydom.com/p/xyz" as sample to "http://mydom.com?mvc_page=xyz.php&mvc_method=show

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

add a permalink / url mapping to the viewer (used for SEO optimization, require mod_rewrite)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green


$this->addPermaLink('/p/', '', 'show', array('mvc_page'));
// map a url "http://mydom.com/p/xyz" as sample to "http://mydom.com?mvc_page=xyz.php&mvc_method=show

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

Parameters

$url_needle
$mvc_page
// default page called for permalink, will be overwritten by requested parameter (GET/POST) and by mapping if exists
$mvc_method
// default method called for permalink, will be overwritten by requested parameter (GET/POST) and by mapping if exists
$mapping
public
# addURLMapping( string $url_needle, string $mvc_page, string $mvc_method, array $mapping )

add a permalink / url mapping to the viewer (used for SEO optimization, require RewriteEngine)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

add a permalink / url mapping to the viewer (used for SEO optimization, require RewriteEngine)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

Parameters

$url_needle
$mvc_page
$mvc_method
$mapping
public
# addURLRouting( string $url_needle, string $mvc_page, string $mvc_method, array $mapping )

add a permalink / url routing to the viewer (used for SEO optimization, require RewriteEngine)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

add a permalink / url routing to the viewer (used for SEO optimization, require RewriteEngine)

Required Rewrite:
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#php file which implements the viewer
RewriteRule · /index.php [L]

Sample:
// should called in your derived viewer before the parent constructor is called
$this->addPermaLink('/article/', 'article.php', 'show', array('num', 'color'));
// map a url "http://mydom.com/article/12345/green" as sample to "http://mydom.com?mvc_page=article.php&mvc_method=show&num=12345&color=green

Notice:
If you use the permalinks in your contant as links consider about to use rel=bookmark in the link"

Parameters

$url_needle
$mvc_page
$mvc_method
$mapping
public array
# getPermaLinkArray( )

return all permalinks set by "addPermaLink"

return all permalinks set by "addPermaLink"

Returns

array
public array
# getURLMappingArray( )

return all url mappings set by "addURLMapping"

return all url mappings set by "addURLMapping"

Returns

array
public array
# getURLRoutingArray( )

return all url routings set by "addURLRouting"

return all url routings set by "addURLRouting"

Returns

array
public boolean
# isAllowedURI( )

check the requested URI is allowed by routing/mapping

sample:
$this->addPermaLink('/p/', '', 'show', array('mvc_page'));
$this->addPermaLink('/cms/', 'cms.php', 'show', array('cms_uri'));

$this->set404($GLOBALS['DOCROOT'].'/templates/404.htm');

if(!$this->isAllowedURI()){
   header_http_error(HTTP_NOT_FOUND);
   print file_get_contents($GLOBALS['DOCROOT'].'/templates/404.htm');
   exit;
}

check the requested URI is allowed by routing/mapping

sample:
$this->addPermaLink('/p/', '', 'show', array('mvc_page'));
$this->addPermaLink('/cms/', 'cms.php', 'show', array('cms_uri'));

$this->set404($GLOBALS['DOCROOT'].'/templates/404.htm');

if(!$this->isAllowedURI()){
   header_http_error(HTTP_NOT_FOUND);
   print file_get_contents($GLOBALS['DOCROOT'].'/templates/404.htm');
   exit;
}

Returns

boolean
final public string|array
# execute( )

execute the subcontroller and return the content to the viewer as string or component array

execute the subcontroller and return the content to the viewer as string or component array

Returns

string|array

Methods inherited from Controller

ScriptProtection(), __destruct(), cacheContent(), clearCachedContent(), getContoller(), getFlags(), getMethod(), getOpcodeCache(), getPage(), getPermaLink(), getReq(), getScriptProtectionVulnerabilities(), getURLMapping(), getURLRouting(), readCachedContent(), setCachePath()

Properties summary

private boolean $m_isInit
# false
private string $m_path_pages
# "./"
private string $m_404
# ""
private string $m_405
# ""
private string $m_501
# ""
private array $m_url_permalink
# array()

Properties inherited from Controller

$m_log_critical_section_id, $m_log_critical_section_maxlock_ms, $m_log_critical_section_path, $m_log_critical_section_sleep_ms, $m_log_delAfter, $m_log_path

crVCL PHP Framework Version 2.9 API documentation generated by ApiGen