Phpxforms documentation

Html
in package

Support class for basic URL & HTML handing

Tags
author

DaVee

version
0.87dev
license

Lesser General Public License 2.1 or later; see http://www.gnu.org/licenses/lgpl-2.1.html

Table of Contents

Properties

$assets  : string
$author  : string
$domain  : string
$file  : string
$img  : string
$media  : string
$method  : string
$multiLang  : bool
$name  : string
$page  : string
$path  : string
$port  : int|null
$rewrite  : bool
$rss  : string
$secure  : bool
$url  : string

Methods

__construct()  : mixed
auth()  : bool
HTTP Basic auth (PHP_AUTH_USER is only in $_SERVER)
css()  : void
Print CSS settings
cssMerge()  : array<string, mixed>
Merge CSS settings
file()  : string
Get link to file
flash()  : string
Get flash object
getAttr()  : string
Convert array to key="value" format
image()  : string
Get image element
imageSet()  : string
Get image element with srcset
isAjax()  : bool
Is request from javascript
isLocal()  : bool
Allow http or //
js()  : void
Print javascript settings
jsMerge()  : array<string, mixed>
Merge javascript settings
link()  : string
Get a element
renderError()  : void
Print simple error page
rss()  : void
Print rss channels
splitWords()  : string
Split long words
src()  : string
Get url to file on server
status()  : bool
Try to set http status headers
truncate()  : string|null
Truncate text with whole words
truncateHtml()  : string|null
Truncate text with html tags (mb_ is not used for impact on speed)
url()  : string
Get full url
urlDomain()  : string
Get root part of url
getDomain()  : string
Get domain name
getDomainPath()  : string
Get domain path
getServerVal()  : string
Get server value
hasVal()  : bool
Check GET param

Properties

$assets

public static string $assets = 'assets/'

$author

public static string $author

$domain

public static string $domain

$file

public static string $file = 'files/'

$img

public static string $img = 'images/'

$media

public static string $media = 'media/'

$method

public static string $method

$multiLang

public static bool $multiLang

$name

public static string $name

$page

public static string $page

$path

public static string $path

$port

public static int|null $port

$rewrite

public static bool $rewrite

$rss

public static string $rss = 'rss/'

$secure

public static bool $secure

$url

public static string $url

Methods

__construct()

public __construct(array<string, mixed> $web) : mixed
Parameters
$web : array<string, mixed>

auth()

HTTP Basic auth (PHP_AUTH_USER is only in $_SERVER)

public static auth(array<string, string> $users, string $realm[, bool $die = true ]) : bool
Parameters
$users : array<string, string>
$realm : string
$die : bool = true
Return values
bool

css()

Print CSS settings

public static css(array<string, mixed> $list[, string|null $mark = null ]) : void
Parameters
$list : array<string, mixed>
$mark : string|null = null

dynamic tag

cssMerge()

Merge CSS settings

public static cssMerge(array<string, mixed> $css, array<string, mixed>|null $new) : array<string, mixed>
Parameters
$css : array<string, mixed>
$new : array<string, mixed>|null
Return values
array<string, mixed>

file()

Get link to file

public static file(string $path, string $name[, string|null $text = '' ][, array<string, string>|null $attrs = null ][, string|null $base = 'FILE' ][, string|null $mark = null ]) : string
Parameters
$path : string
$name : string
$text : string|null = ''
$attrs : array<string, string>|null = null
$base : string|null = 'FILE'
$mark : string|null = null
Return values
string

flash()

Get flash object

public static flash(string $path, string $name, int $height, int $width[, array<string, string> $para = [] ]) : string
Parameters
$path : string
$name : string
$height : int
$width : int
$para : array<string, string> = []
Return values
string

getAttr()

Convert array to key="value" format

public static getAttr(array<string, string>|null $attrs[, string $slash = '"' ]) : string
Parameters
$attrs : array<string, string>|null
$slash : string = '"'
Return values
string

image()

Get image element

public static image(string $path, string $name[, string|null $alt = '' ][, array<string, string>|null $attrs = null ][, string|null $base = 'IMG' ][, string|null $mark = null ]) : string
Parameters
$path : string
$name : string
$alt : string|null = ''
$attrs : array<string, string>|null = null
$base : string|null = 'IMG'
$mark : string|null = null
Return values
string

imageSet()

Get image element with srcset

public static imageSet(string $path, array<string, string> $names[, string|null $alt = '' ][, array<string, string>|null $attrs = null ][, string|null $base = 'IMG' ][, string|null $mark = null ]) : string
Parameters
$path : string
$names : array<string, string>
$alt : string|null = ''
$attrs : array<string, string>|null = null
$base : string|null = 'IMG'
$mark : string|null = null
Return values
string

isAjax()

Is request from javascript

public static isAjax() : bool
Return values
bool

isLocal()

Allow http or //

public static isLocal(string|null $url) : bool
Parameters
$url : string|null
Return values
bool

js()

Print javascript settings

public static js(array<string, mixed> $list[, string|null $mark = null ][, bool $xml = true ]) : void
Parameters
$list : array<string, mixed>
$mark : string|null = null

dynamic tag

$xml : bool = true

jsMerge()

Merge javascript settings

public static jsMerge(array<string, mixed> $scripts, array<string, mixed>|null $new) : array<string, mixed>
Parameters
$scripts : array<string, mixed>
$new : array<string, mixed>|null
Return values
array<string, mixed>

link()

Get a element

public static link(string $url[, string|null $value = '' ][, array<string, string>|null $attrs = null ][, string|null $base = null ]) : string
Parameters
$url : string
$value : string|null = ''
$attrs : array<string, string>|null = null
$base : string|null = null
Return values
string

renderError()

Print simple error page

public static renderError(string $title[, string|int $type = 404 ][, int|null $line = null ]) : void
Parameters
$title : string
$type : string|int = 404
$line : int|null = null

rss()

Print rss channels

public static rss([array<string|int, string> $list = [''] ]) : void
Parameters
$list : array<string|int, string> = ['']

splitWords()

Split long words

public static splitWords(string $text, int $maxLength[, string $break = '- ' ]) : string
Parameters
$text : string
$maxLength : int
$break : string = '- '
Return values
string

src()

Get url to file on server

public static src(string $path, string $name[, string|null $base = null ][, string|null $mark = null ]) : string
Parameters
$path : string
$name : string
$base : string|null = null
$mark : string|null = null
Return values
string

status()

Try to set http status headers

public static status(int $type) : bool
Parameters
$type : int
Return values
bool

truncate()

Truncate text with whole words

public static truncate(string|null $string, int $length[, int $begin = 0 ][, string $break = ' ' ][, string $postfix = "…" ]) : string|null
Parameters
$string : string|null
$length : int

max output length

$begin : int = 0
$break : string = ' '
$postfix : string = "…"
Return values
string|null

truncateHtml()

Truncate text with html tags (mb_ is not used for impact on speed)

public static truncateHtml(string|null $html, int $length[, string $break = ' ' ][, string $postfix = "…" ]) : string|null
Parameters
$html : string|null
$length : int
$break : string = ' '
$postfix : string = "…"
Return values
string|null

url()

Get full url

public static url([string $uri = '' ][, string|null $page = null ][, array<string, mixed>|null $params = null ][, bool $href = true ][, string $dir = '' ]) : string
Parameters
$uri : string = ''
$page : string|null = null
$params : array<string, mixed>|null = null
$href : bool = true
$dir : string = ''
Return values
string

urlDomain()

Get root part of url

public static urlDomain([string $uri = '' ][, string|null $domain = null ][, bool|null $secure = null ][, string $dir = '' ]) : string
Parameters
$uri : string = ''
$domain : string|null = null
$secure : bool|null = null
$dir : string = ''
Return values
string

getDomain()

Get domain name

protected static getDomain() : string
Return values
string

getDomainPath()

Get domain path

protected static getDomainPath() : string
Return values
string

getServerVal()

Get server value

protected static getServerVal(string $name[, int $filter = FILTER_DEFAULT ]) : string
Parameters
$name : string
$filter : int = FILTER_DEFAULT
Return values
string

hasVal()

Check GET param

protected static hasVal(string $name) : bool
Parameters
$name : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results