[ Index ]

PHP Cross Reference of PHK Manager

title

Body

[close]

/PHK/ -> Base.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: 803 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 39 functions

  mnt()
  flags()
  path()
  mtime()
  automapID()
  options()
  parentMnt()
  plugin()
  __construct()
  validate()
  init()
  mapDefined()
  setCache()
  fileIsPackage()
  dataIsPackage()
  cacheEnabled()
  umount()
  uri()
  sectionURI()
  commandURI()
  baseURI()
  automapURI()
  option()
  webAccessAllowed()
  gotoMain()
  webTunnel()
  mimeHeader()
  mimeType()
  isPHPSourcePath()
  proxy()
  crcCheck()
  supportsPhpVersion()
  acceleratorIsPresent()
  buildInfo()
  subpathURL()
  setSubpath()
  backend()
  __call()
  prolog()

Functions
Functions that are not part of a class:

mnt()   X-Ref
No description

flags()   X-Ref
No description

path()   X-Ref
No description

mtime()   X-Ref
No description

automapID()   X-Ref
No description

options()   X-Ref
No description

parentMnt()   X-Ref
No description

plugin()   X-Ref
No description

__construct($parentMnt,$mnt,$path,$flags,$mtime)   X-Ref
No description

validate()   X-Ref
No description

init($options,$buildInfo)   X-Ref
No description

mapDefined()   X-Ref
No description

setCache($toggle)   X-Ref
No description

fileIsPackage($path)   X-Ref
Check if a given path contains a PHK package

param: string $path    path to check (can be virtual)
return: boolean

dataIsPackage($data)   X-Ref
Check if a data buffer contains a PHK package

param: string $data    data buffer to check
return: boolean

cacheEnabled($command,$params,$path)   X-Ref
No description

umount()   X-Ref
No description

uri($path)   X-Ref
No description

sectionURI($section)   X-Ref
No description

commandURI($command)   X-Ref
No description

baseURI()   X-Ref
No description

automapURI()   X-Ref
Returns the URI of the map

return: string

option($key)   X-Ref
Returns an option

If the option is not set, returns null.

The 'OPTIONS' section is mandatory in a package.

param: string $key The option name
return: any|null Option value or null if the requested option is not set

webAccessAllowed($path)   X-Ref
No description

gotoMain($web_run_script)   X-Ref
No description

webTunnel($path=null,$webinfo=false)   X-Ref
No description

mimeHeader($path)   X-Ref
Sends a mime header corresponding to a path

Actually, we use only the file suffix (the path can correspond to an existing
node or not).

If the suffix does not correspond to anything we know, nothing is sent
(defaults to text/html on Apache, don't know if it can change on another
SAPI).

param: string $path
return: void

mimeType($path)   X-Ref
Returns the mime-type corresponding to a given path, or null if the
suffix does not correspond to anything we know

Searches :

1. The 'mime-types' option
2. The built-in mime table
3. If the suffix contains 'php', sets the type to 'application/x-httpd-php'

param: string $path
return: string|null The mime type or null if file suffix is unknown

isPHPSourcePath($path)   X-Ref
Should we consider this path as a PHP source file ?

In order to be identified as PHP source, a path must be associated with Mime
type 'application/x-httpd-php'.

param: string $path
return: boolean

proxy()   X-Ref
No description

crcCheck()   X-Ref
Checks the CRC of the PHK archive file

Generates an exception if the check fails

return: void

supportsPhpVersion()   X-Ref
No description

acceleratorIsPresent()   X-Ref
Is the PHK accelerator in use or not ?

return: boolean

buildInfo($name=null)   X-Ref
Returns a build-time information field or the whole array

Unlike options, an unknown key throws an error

param: string|null $name Field name
return: array|string|null The field's content or null if it does not exist

subpathURL($path)   X-Ref
No description

setSubpath()   X-Ref
No description

backend()   X-Ref
No description

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

prolog($file,&$cmd,&$ret)   X-Ref
No description



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