[ Index ]

PHP Cross Reference of PHK Manager




/PHK/ -> Backend.php (summary)

(no description)

Copyright: Francois Laupretre <phk@tekwire.net>
License: http://www.apache.org/licenses/LICENSE-2.0 Apache License, V 2.0
File Size: 789 lines (20 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Backend:: (25 methods):

Class: Backend  - X-Ref

This class contains the non-accelerated runtime code. This code must
never be accessed during 'fast path' scenarios.

Each \PHK\Backend instance is associated with a 'front-end' PHK instance
(accelerated or not).

<Public API>
__construct($front)   X-Ref
No description

__get($name)   X-Ref
No description

__call($method,$args)   X-Ref
No description

test()   X-Ref
No description

envinfo()   X-Ref
No description

showfiles()   X-Ref
No description

showmap($subfile_to_url_function=null)   X-Ref
No description

pluginInfo($html)   X-Ref
<Info> Displays information about the plugin

If the plugin object defines a method name '_webinfo', this method is called
with the $html parameter.

If the plugin is not defined, just displays a small informative message

param: boolean $html Whether to display in html or raw text
return: void

showOption($html,$opt,$default=null)   X-Ref
<Info> Displays an option and its value

An URL can be set in an option. Syntax: 'text to display <url>'
In HTML mode, only the text is displayed and an hyperlink is generated
In text mode, it is displayed as-is.
URLs starting with 'http://' are automatically recognized
param: boolean $html Whether to display in html or raw text
param: string $opt Option name
return: void

infoSection($html,$title)   X-Ref
<Info> Start a new information section

param: boolean $html Whether to display in html or raw text
param: string $title The title to display
return: void

showInfoLine($html,$string,$value,$url=null,$newwin=true)   X-Ref
<Info> Displays an information line

In html mode, the information is displayed in a table. This table must
have been opened by a previous call to \PHK::startInfoTable().

Note: The URLs starting with a '/' char are internal (generated by \PHK\Web\Info
) and, so, are displayed in html mode only.

param: boolean $html Whether to display in html or raw text
param: string $string The left side (without ':')
param: string|boolean $value The value to display. If boolean, displays 'Yes'
param: string|null $url An URL to associate with this value. Null if no URL.
param: boolean $newwin Used in html mode only. Whether the URL link opens
return: void

startInfoTable($html)   X-Ref
<Info> Starts an HTML table

In text mode, does nothing.

This function is public because it can be called from the plugin's _webinfo

param: boolean $html Whether to display in html or raw text
return: void

endInfoTable($html)   X-Ref
No description

info()   X-Ref
No description

techinfo()   X-Ref
No description

autoFile($prefix)   X-Ref
Returns a subfile content for a multi-type metafile

File name : <prefix>.<type> - Type is 'txt' or 'htm'.

A text file can be transformed to html, but the opposite is not possible.

Type is determined by the SAPI type (CLI => txt, else => htm).

param: string $prefix Prefix to search for
return: string|null The requested content or null if not found

autoOption($name)   X-Ref
Returns a multi-type content from an option name

Option ($name.'_prefix') gives the prefix to send to autoFile()

param: string $name Option prefix
return: string Requested content or an informative error string.

isCallablePluginMethod($method)   X-Ref
Checks if the plugin class is defined and contains a given method

param: string $method
return: boolean

callPluginMethod($method)   X-Ref
Calls a given method in the plugin object

param: string method
return: * the method's return value

pathList()   X-Ref
No description

sectionList()   X-Ref
No description

check()   X-Ref
Check a package

TODO: There's a lot more to check...

return: array of error messages

subpathURL($path)   X-Ref
No description

cmdUsage($msg=null)   X-Ref
No description

builtinProlog($file)   X-Ref
No description

Generated: Thu Jun 4 18:33:15 2015 Cross-referenced by PHPXref 0.7.1