Sitellite Application Framework
Class Tree         Index         All Elements

Element index for package Misc

[ a ] [ c ] [ d ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ]

a

addFilter
in file Ini.php, method Ini::addFilter()
    Adds a filter to the parse() process.
addHeader
in file Document.php, method Document::addHeader()
    Adds an HTTP header to send when compile() is called.
addLink
in file Document.php, method Document::addLink()
    Adds a link tag to the global template.
addMeta
in file Document.php, method Document::addMeta()
    Adds a metadata property to the global template.
addScript
in file Document.php, method Document::addScript()
    Adds a script to the global template.
addStyle
in file Document.php, method Document::addStyle()
    Adds a stylesheet to the global template.
Alt
in file Alt.php, method Alt::Alt()
    Constructor method. If the first parameter is an array, it is used to set the $vals property. If not, up to three parameters can be passed, which are fed into the $vals property array.
Alt
in file Alt.php, class Alt
    Alt is a tiny class that alternates through a list of values each time you call the next () method. When it gets to the end of the list, the pointer is reset to the beginning.
Alt.php
procedural page Alt.php
top

c

clear
in file Ini.php, method Ini::clear()
    Clears the list of registered filters, and adds one filter
colour_diff
in file Colour.php, function colour_diff()
colour_gradient
in file Colour.php, function colour_gradient()
    Returns an array of colours between the two specified colours.
compile
in file Document.php, method Document::compile()
    "Compiles" the document. This includes sending any headers, checking isExternal(), then calling useTemplate() to render the document to the appropriate template.
count
in file Lister.php, method Lister::count()
CURLOPT_BINARYTRANSFER
in file Curl.php, constant CURLOPT_BINARYTRANSFER
CURLOPT_BUFFERSIZE
in file Curl.php, constant CURLOPT_BUFFERSIZE
CURLOPT_CAINFO
in file Curl.php, constant CURLOPT_CAINFO
CURLOPT_CAPATH
in file Curl.php, constant CURLOPT_CAPATH
CURLOPT_CLOSEPOLICY
in file Curl.php, constant CURLOPT_CLOSEPOLICY
CURLOPT_CONNECTTIMEOUT
in file Curl.php, constant CURLOPT_CONNECTTIMEOUT
CURLOPT_COOKIE
in file Curl.php, constant CURLOPT_COOKIE
CURLOPT_COOKIEFILE
in file Curl.php, constant CURLOPT_COOKIEFILE
CURLOPT_COOKIEJAR
in file Curl.php, constant CURLOPT_COOKIEJAR
CURLOPT_CRLF
in file Curl.php, constant CURLOPT_CRLF
CURLOPT_CUSTOMREQUEST
in file Curl.php, constant CURLOPT_CUSTOMREQUEST
CURLOPT_DNS_CACHE_TIMEOUT
in file Curl.php, constant CURLOPT_DNS_CACHE_TIMEOUT
CURLOPT_DNS_USE_GLOBAL_CACHE
in file Curl.php, constant CURLOPT_DNS_USE_GLOBAL_CACHE
CURLOPT_EGBSOCKET
in file Curl.php, constant CURLOPT_EGBSOCKET
CURLOPT_ENCODING
in file Curl.php, constant CURLOPT_ENCODING
CURLOPT_FAILONERROR
in file Curl.php, constant CURLOPT_FAILONERROR
CURLOPT_FILE
in file Curl.php, constant CURLOPT_FILE
CURLOPT_FILETIME
in file Curl.php, constant CURLOPT_FILETIME
CURLOPT_FOLLOWLOCATION
in file Curl.php, constant CURLOPT_FOLLOWLOCATION
CURLOPT_FORBID_REUSE
in file Curl.php, constant CURLOPT_FORBID_REUSE
CURLOPT_FRESH_CONNECT
in file Curl.php, constant CURLOPT_FRESH_CONNECT
CURLOPT_FTPAPPEND
in file Curl.php, constant CURLOPT_FTPAPPEND
CURLOPT_FTPASCII
in file Curl.php, constant CURLOPT_FTPASCII
CURLOPT_FTPLISTONLY
in file Curl.php, constant CURLOPT_FTPLISTONLY
CURLOPT_FTPPORT
in file Curl.php, constant CURLOPT_FTPPORT
CURLOPT_FTPSSLAUTH
in file Curl.php, constant CURLOPT_FTPSSLAUTH
CURLOPT_FTP_USE_EPRT
in file Curl.php, constant CURLOPT_FTP_USE_EPRT
CURLOPT_FTP_USE_EPSV
in file Curl.php, constant CURLOPT_FTP_USE_EPSV
CURLOPT_HEADER
in file Curl.php, constant CURLOPT_HEADER
CURLOPT_HEADERFUNCTION
in file Curl.php, constant CURLOPT_HEADERFUNCTION
CURLOPT_HTTP200ALIASES
in file Curl.php, constant CURLOPT_HTTP200ALIASES
CURLOPT_HTTPAUTH
in file Curl.php, constant CURLOPT_HTTPAUTH
CURLOPT_HTTPGET
in file Curl.php, constant CURLOPT_HTTPGET
CURLOPT_HTTPHEADER
in file Curl.php, constant CURLOPT_HTTPHEADER
CURLOPT_HTTPPROXYTUNNEL
in file Curl.php, constant CURLOPT_HTTPPROXYTUNNEL
CURLOPT_HTTP_VERSION
in file Curl.php, constant CURLOPT_HTTP_VERSION
CURLOPT_INFILE
in file Curl.php, constant CURLOPT_INFILE
CURLOPT_INFILESIZE
in file Curl.php, constant CURLOPT_INFILESIZE
CURLOPT_INTERFACE
in file Curl.php, constant CURLOPT_INTERFACE
CURLOPT_KRB4LEVEL
in file Curl.php, constant CURLOPT_KRB4LEVEL
CURLOPT_LOW_SPEED_LIMIT
in file Curl.php, constant CURLOPT_LOW_SPEED_LIMIT
CURLOPT_LOW_SPEED_TIME
in file Curl.php, constant CURLOPT_LOW_SPEED_TIME
CURLOPT_MAXCONNECTS
in file Curl.php, constant CURLOPT_MAXCONNECTS
CURLOPT_MAXREDIRS
in file Curl.php, constant CURLOPT_MAXREDIRS
CURLOPT_MUTE
in file Curl.php, constant CURLOPT_MUTE
CURLOPT_NETRC
in file Curl.php, constant CURLOPT_NETRC
CURLOPT_NOBODY
in file Curl.php, constant CURLOPT_NOBODY
CURLOPT_NOPROGRESS
in file Curl.php, constant CURLOPT_NOPROGRESS
CURLOPT_NOSIGNAL
in file Curl.php, constant CURLOPT_NOSIGNAL
CURLOPT_PASSWDFUNCTION
in file Curl.php, constant CURLOPT_PASSWDFUNCTION
CURLOPT_PORT
in file Curl.php, constant CURLOPT_PORT
CURLOPT_POST
in file Curl.php, constant CURLOPT_POST
CURLOPT_POSTFIELDS
in file Curl.php, constant CURLOPT_POSTFIELDS
CURLOPT_POSTQUOTE
in file Curl.php, constant CURLOPT_POSTQUOTE
CURLOPT_PROXY
in file Curl.php, constant CURLOPT_PROXY
CURLOPT_PROXYAUTH
in file Curl.php, constant CURLOPT_PROXYAUTH
CURLOPT_PROXYPORT
in file Curl.php, constant CURLOPT_PROXYPORT
CURLOPT_PROXYTYPE
in file Curl.php, constant CURLOPT_PROXYTYPE
CURLOPT_PROXYUSERPWD
in file Curl.php, constant CURLOPT_PROXYUSERPWD
CURLOPT_PUT
in file Curl.php, constant CURLOPT_PUT
CURLOPT_QUOTE
in file Curl.php, constant CURLOPT_QUOTE
CURLOPT_RANDOM_FILE
in file Curl.php, constant CURLOPT_RANDOM_FILE
CURLOPT_RANGE
in file Curl.php, constant CURLOPT_RANGE
CURLOPT_READFUNCTION
in file Curl.php, constant CURLOPT_READFUNCTION
CURLOPT_REFERER
in file Curl.php, constant CURLOPT_REFERER
CURLOPT_RESUME_FROM
in file Curl.php, constant CURLOPT_RESUME_FROM
CURLOPT_RETURNTRANSFER
in file Curl.php, constant CURLOPT_RETURNTRANSFER
CURLOPT_SSLCERT
in file Curl.php, constant CURLOPT_SSLCERT
CURLOPT_SSLCERTPASSWD
in file Curl.php, constant CURLOPT_SSLCERTPASSWD
CURLOPT_SSLCERTTYPE
in file Curl.php, constant CURLOPT_SSLCERTTYPE
CURLOPT_SSLENGINE
in file Curl.php, constant CURLOPT_SSLENGINE
CURLOPT_SSLENGINE_DEFAULT
in file Curl.php, constant CURLOPT_SSLENGINE_DEFAULT
CURLOPT_SSLKEY
in file Curl.php, constant CURLOPT_SSLKEY
CURLOPT_SSLKEYPASSWD
in file Curl.php, constant CURLOPT_SSLKEYPASSWD
CURLOPT_SSLKEYTYPE
in file Curl.php, constant CURLOPT_SSLKEYTYPE
CURLOPT_SSLVERSION
in file Curl.php, constant CURLOPT_SSLVERSION
CURLOPT_SSL_CIPHER_LIST
in file Curl.php, constant CURLOPT_SSL_CIPHER_LIST
CURLOPT_SSL_VERIFYHOST
in file Curl.php, constant CURLOPT_SSL_VERIFYHOST
CURLOPT_SSL_VERIFYPEER
in file Curl.php, constant CURLOPT_SSL_VERIFYPEER
CURLOPT_STDERR
in file Curl.php, constant CURLOPT_STDERR
CURLOPT_TIMECONDITION
in file Curl.php, constant CURLOPT_TIMECONDITION
CURLOPT_TIMEOUT
in file Curl.php, constant CURLOPT_TIMEOUT
CURLOPT_TIMEVALUE
in file Curl.php, constant CURLOPT_TIMEVALUE
CURLOPT_TRANSFERTEXT
in file Curl.php, constant CURLOPT_TRANSFERTEXT
CURLOPT_UNRESTRICTED_AUTH
in file Curl.php, constant CURLOPT_UNRESTRICTED_AUTH
CURLOPT_UPLOAD
in file Curl.php, constant CURLOPT_UPLOAD
CURLOPT_URL
in file Curl.php, constant CURLOPT_URL
CURLOPT_USERAGENT
in file Curl.php, constant CURLOPT_USERAGENT
CURLOPT_USERPWD
in file Curl.php, constant CURLOPT_USERPWD
CURLOPT_VERBOSE
in file Curl.php, constant CURLOPT_VERBOSE
CURLOPT_WRITEFUNCTION
in file Curl.php, constant CURLOPT_WRITEFUNCTION
CURLOPT_WRITEHEADER
in file Curl.php, constant CURLOPT_WRITEHEADER
curl_close
in file Curl.php, function curl_close()
curl_errno
in file Curl.php, function curl_errno()
curl_error
in file Curl.php, function curl_error()
curl_exec
in file Curl.php, function curl_exec()
curl_init
in file Curl.php, function curl_init()
curl_setopt
in file Curl.php, function curl_setopt()
Colour.php
procedural page Colour.php
Curl.php
procedural page Curl.php
top

d

doAll
in file FakeEmail.php, method FakeEmail::doAll()
    Provides all three obscuring methods in one, which means it will display as 'you at yoursite dot com', but will provide a mailto link as well.
Document
in file Document.php, method Document::Document()
    Constructor method. If $data is passed to the constructor, it will pass the $data on to the set() method.
Document
in file Document.php, class Document
    This package contains the data of the current page request, and renders it for the Sitellite Content Server. It also provides several global-level functions that provide developers with control over the contents and the properties of the page request.
Document.php
procedural page Document.php
top

f

FakeEmail
in file FakeEmail.php, class FakeEmail
    A class used to generate obscured email addresses, so as to make it more difficult for spambots to recognize them.
filter
in file Ini.php, method Ini::filter()
    Filters the specified data through all registered filters.
fromXml
in file Ini.php, method Ini::fromXml()
    Parses an XML document into an INI $struct, which can then be saved to a file or processed further.
FakeEmail.php
procedural page FakeEmail.php
top

g

get
in file Lister.php, method Lister::get()
getSection
in file Document.php, method Document::getSection()
    Returns the section name of the current page, or false if the page is
getSort
in file TableHeader.php, method TableHeader::getSort()
getTitle
in file Document.php, method Document::getTitle()
    Gets the title of the current or the specified page.
get_searchengine_keywords
in file Search.php, function get_searchengine_keywords()
    Check if the previous request was a search engine results page. If so, then parse the search keywords.
top

h

$headers
in file Document.php, variable Document::$headers
    List of HTTP headers to be sent with the document. @see addHeader()
top

i

$iterator
in file Lister.php, variable Lister::$iterator
Ini
in file Ini.php, method Ini::Ini()
    Constructor method.
Ini
in file Ini.php, class Ini
    Class for parsing, transforming, and writing files in the INI format, as defined by the PHP parse_ini_file() function.
ini_add_filter
in file Ini.php, function ini_add_filter()
    Adds a filter to the global $ini object. Alias of addFilter() method.
ini_clear
in file Ini.php, function ini_clear()
    Clears the list of filters in the global $ini object.
ini_filter
in file Ini.php, function ini_filter()
    Filters the specified data using the global $ini object.
ini_filter_replace_backticks
in file Ini.php, function ini_filter_replace_backticks()
    Backtick INI filter. Replaces backticks (`) with double-quotes (").
ini_filter_split_commas
in file Ini.php, function ini_filter_split_commas()
    Comma-splitting INI filter. Breaks a string into a list by the commas in it. Note: An optional single space is allowed following commas, and will be trimmed.
ini_filter_split_comma_single
in file Ini.php, function ini_filter_split_comma_single()
    Single-comma-splitting INI filter. Breaks a string into two by the first comma in it. Note: An optional single space is allowed following the comma, and will be trimmed.
ini_parse
in file Ini.php, function ini_parse()
    Parses an INI file -- calls parse() on a global $ini object.
ini_write
in file Ini.php, function ini_write()
    Writes an INI data string from the specified structure.
insertComments
in file FakeEmail.php, method FakeEmail::insertComments()
    Doesn't display the address as a link, but inserts comments into it so as to make it difficult to read the address in the source code, but so that it still displays on the page as a normal address.
isCurrent
in file TableHeader.php, method TableHeader::isCurrent()
isExternal
in file Document.php, method Document::isExternal()
    Checks for an $external property of the document object, which if found is understood to represent an external document that this object is actually an alias of, and so it will forward the request on to that document.
isParent
in file Document.php, method Document::isParent()
    Determines whether the specified page ID is a parent of the current page.
iterate
in file Lister.php, method Lister::iterate()
Ini.php
procedural page Ini.php
top

l

$list
in file Lister.php, variable Lister::$list
Lister
in file Lister.php, class Lister
Lister.php
procedural page Lister.php
top

m

$meta
in file Document.php, variable Document::$meta
    List of metadata attributes, which can be rendered as HTML meta tags using the makeMeta() method. To render them into your XT templates, simply add an xt:var tag with the name "makeMeta".
makeJavascript
in file Document.php, method Document::makeJavascript()
    Note: Deprecated in favour of XT's automatic tag binding capabilities.
makeMeta
in file Document.php, method Document::makeMeta()
    Note: Deprecated in favour of XT's automatic tag binding capabilities.
makeWords
in file FakeEmail.php, method FakeEmail::makeWords()
    Doesn't display the address as a link, but turns the various symbol characters into words and spaces the address out so that it reads properly aloud, but it doesn't look like an email address.
microbench
in file Microbench.php, function microbench()
microbench_display
in file Microbench.php, function microbench_display()
Microbench.php
procedural page Microbench.php
top

n

next
in file Alt.php, method Alt::next()
    Advances the internal counter and returns the next value.
top

o

obfuscateLink
in file FakeEmail.php, method FakeEmail::obfuscateLink()
    Still provides a mailto link, but obfuscates the email address inside the anchor link tag by converting various characters into alternate, but valid, encodings.
top

p

$pregReplacements
in file Shorthand.php, variable PHPShorthand::$pregReplacements
    The list of preg_replace()-able tokens within the expression.
page_add_header
in file Document.php, function page_add_header()
    Adds an HTTP header to send with the page.
page_add_link
in file Document.php, function page_add_link()
    Adds a link tag to the page.
page_add_meta
in file Document.php, function page_add_meta()
    Adds an HTML meta tag to the page.
page_add_script
in file Document.php, function page_add_script()
    Adds a JavaScript script to the page.
page_add_style
in file Document.php, function page_add_style()
    Adds a CSS stylesheet to the page.
page_below
in file Document.php, function page_below()
    Sets the below_page property of the page. This sets the position of the page within the web site breadcrumbs.
page_description
in file Document.php, function page_description()
    Sets the description of the page.
page_get_section
in file Document.php, function page_get_section()
    Alias of the getSection() method. Returns the first section page that the current page is a child of.
page_get_title
in file Document.php, function page_get_title()
    Alias of the getTitle() method.
page_head_title
in file Document.php, function page_head_title()
    Sets the head_title of the page.
page_id
in file Document.php, function page_id()
    Sets the page ID to something other than its default.
page_is_parent
in file Document.php, function page_is_parent()
    Alias of the isParent() method.
page_keywords
in file Document.php, function page_keywords()
    Sets the keywords of the page.
page_nav_title
in file Document.php, function page_nav_title()
    Sets the nav_title of the page.
page_onblur
in file Document.php, function page_onblur()
    Adds an onblur="" handler to the page. This can be rendered in your XT templates in the onblur attribute of your HTML body tag, by inserting the value "${onblur}".
page_onclick
in file Document.php, function page_onclick()
    Adds an onclick="" handler to the page. This can be rendered in your XT templates in the onclick attribute of your HTML body tag, by inserting the value "${onclick}".
page_onfocus
in file Document.php, function page_onfocus()
    Adds an onfocus="" handler to the page. This can be rendered in your XT templates in the onfocus attribute of your HTML body tag, by inserting the value "${onfocus}".
page_onload
in file Document.php, function page_onload()
    Adds an onload="" handler to the page. This can be rendered in your XT templates in the onload attribute of your HTML body tag, by inserting the value "${onload}".
page_onunload
in file Document.php, function page_onunload()
    Adds an onunload="" handler to the page. This can be rendered in your XT templates in the onunload attribute of your HTML body tag, by inserting the value "${onunload}".
page_template
in file Document.php, function page_template()
    Sets the template to use to render the page.
page_template_set
in file Document.php, function page_template_set()
    Sets the template set (ie. theme) to use to render the page.
page_title
in file Document.php, function page_title()
    Sets the title of the page.
parse
in file Ini.php, method Ini::parse()
    Parses the specified file as an INI file. Please note that this method defaults to assuming INI files _do_ have $sections, whereas PHP's parse_ini_file() function assumes the opposite.
parseStr
in file Ini.php, method Ini::parseStr()
PHPShorthand
in file Shorthand.php, class PHPShorthand
    Converts a shorthand code syntax into PHP code. The syntax is as follows:
top

r

RPC.php
procedural page RPC.php
replaceGlobals
in file Shorthand.php, method PHPShorthand::replaceGlobals()
    Replaces the keyword GLOBALS with the specified $newReg in all regexp transformations. Alternately, if $replace is provided, it will add a new regular expression to the list of transformations to perform.
reset
in file Alt.php, method Alt::reset()
    Returns the internal counter to 0 and returns nothing.
reset
in file Lister.php, method Lister::reset()
rpc_handle
in file RPC.php, function rpc_handle()
    Takes an object and the parameter list from a box call, executes
rpc_init
in file RPC.php, function rpc_init()
rpc_response
in file RPC.php, function rpc_response()
    Creates a proper rpc server response out of the parameters passed to this function (uses func_get_args(), so pass it whatever you want).
rpc_serialize
in file RPC.php, function rpc_serialize()
    Serialize the specified PHP data into a JavaScript-compatible string.
top

s

$scripts
in file Document.php, variable Document::$scripts
    List of javascript scripts, which can be rendered as HTML script tags using the makeJavascript() method. To render them into your XT templates, simply add an xt:var tag with the name "makeJavascript".
$sprintfVars
in file Shorthand.php, variable PHPShorthand::$sprintfVars
    The list of quoted parts of the current expression.
$strReplacements
in file Shorthand.php, variable PHPShorthand::$strReplacements
    The list of str_replace()-able tokens within the expression.
$styles
in file Document.php, variable Document::$styles
    Array used to prevent duplicate loading of stylesheets.
Search.php
procedural page Search.php
Shorthand.php
procedural page Shorthand.php
saf_misc_search_content_filter
in file Search.php, function saf_misc_search_content_filter()
    If you would like search terms to be automatically highlighted in your web pages, add 'filter 1 = "body: saf.Misc.Search"' to the modes.php file in your template set, under the appropriate output mode.
search_bar
in file Search.php, function search_bar()
    Returns a bar that displays "Highlighting Search Terms: a, b, c <Search Again>".
search_highlight
in file Search.php, function search_highlight()
    Highlights all of the query terms in the specified string, wrapping them in <span class="highlighted"></span> tags.
search_split_query
in file Search.php, function search_split_query()
sendHeaders
in file Document.php, method Document::sendHeaders()
    Sends all HTTP headers associated with the current document.
set
in file Document.php, method Document::set()
    Sets properties of the current Document object, such as title, id, body, etc.
set
in file Lister.php, method Lister::set()
top

t

TableHeader.php
procedural page TableHeader.php
TableHeader
in file TableHeader.php, method TableHeader::TableHeader()
TableHeader
in file TableHeader.php, class TableHeader
toXml
in file Ini.php, method Ini::toXml()
    Returns the specified INI structure as an XML document.
transform
in file Shorthand.php, method PHPShorthand::transform()
    Transforms the specified expression into valid PHP
top

u

useTemplate
in file Document.php, method Document::useTemplate()
    Determines which template to use to render the document for output to the visitor. The template is chosen based on the following conditions:
top

v

$vals
in file Alt.php, variable Alt::$vals
    List of values to alternate between.
top

w

walk
in file Lister.php, method Lister::walk()
write
in file Ini.php, method Ini::write()
    Turns an INI structure into an INI formatted string, ready for writing to a file.
writeValue
in file Ini.php, method Ini::writeValue()
    Formats an individual value from an INI file, using quotes if any invalid characters are present.
top

Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:16:31 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2