Packageindex Classtrees Modulegroups Elementlist Report XML Files
$ & / a b c C d E e F f g h i l L M m N o p P q R r s S t U u _

$

$Request->getScript() Included file in class F1CMS
$Request->getSidebarScript() Included file in class F1CMS

&

&getSection Function in class SectionRequest
Get current section as a Section object.
&singleton Function in class Err
ONE instance of this class.
&singleton Function in class Log
Get ONE instance of this class.
&singleton Function in class Modules
Returns a reference to a single instance of this object
&singleton Function in class PathInfo
Instantiate one copy of this object.
&singleton Function in class SectionNavigatorOptimized
Instantiate one copy of this object.
&singleton Function in class SectionNavigator
Instantiate one copy of this object.
&singleton Function in class Site
Instantiate one copy of this object.
&singleton Function in class StxPrefs
Instantiate one copy of this object.
&newError Function in class Err
This is the public method NewError, it's the static
&addError Function in class Err
This is the public method AddError, it adds
&getAncestorCollection Function in class Section
Uses SectionNavigator to return a pxdb_collection of the section's ancestors.
&getAncestorCollection Function in class SectionNavigator
Returns a pxdb_collection containing all sections that are ancestors of the current section.
&getParentSection Function in class Section
Returns the parent section object for the current section, if it has one.
&_getChildrenCollection Function in class SectionNavigatorOptimized
Generates the pxdb_collection for the getChildren method,
&_getChildrenCollection Function in class SectionNavigator
Generates the pxdb_collection for the getChildren method,
&_getSectionByUrlPath Function in class SectionNavigatorOptimized
Gets a Section by its URL Path**, optimized for MySQL db performance
&_getSectionByUrlPath Function in class SectionNavigator
Abstraction method. Gets a Section by its URL Path
&_getParentCollection Function in class SectionNavigatorOptimized
Abstraction method for implementation of getting the collection with a Parent in it.
&_getParentCollection Function in class SectionNavigator
Abstraction method for implementation of getting the collection with a Parent in it.
&getChildren Function in class SectionNavigator
Returns the collection object with the children of the current node
&getHomeSection Function in class SectionNavigator
Gets the home node section and returns it
&_getHomeSection Function in class SectionNavigator
Abstraction method for implementaion of getHomeSection method, although
&getParent Function in class SectionNavigator
Returns the parent to the current or passed section
&getNextSection Function in class SectionNavigator
Iterator for moving through the nodes. Use getDepth() to determine the current
&getRequest Function in class Site
Gets the top-level (page-request-level) Request object.
&getCache Function in class Site
Gets the PEAR::Cache instance.
&getUser Function in class Site
Gets the currently logged-in user (pxdb_user) if set.
&requestFactory Function in class StxUtilities
A sort of factory method for the Request object, that looks
&listFromPicktable Function in class StxUtilities
single function call for getting a listWidget object based on
&listFromPicktableTree Function in class StxUtilities
single function call for getting a listWidget object based on
&stx_request_factory Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
A sort of factory method for the Request object, that looks
&_request_factory Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for &stx_request_factory()
&stx_list_from_picktable Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
single function call for getting a listWidget object based on
&list_from_picktable Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
alias for &stx_list_from_picktable()
&stx_list_from_picktable_tree Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
single function call for getting a listWidget object based on
&list_from_picktable_tree Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for &stx_list_from_picktable_tree()

/

/home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php Module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php.
* Truncates a block of text to the nearest end-of-sentence character after

C

Cache/Output.php Included file in class F1CMS_Cache
$Cache Variable in Class Site
Global Cache_Output object.

E

Err Class Err.
Err Function in class Err
This is the public Method method,

F

F1CMS Class F1CMS.
F1CMS_Cache Class F1CMS_Cache.
A fix to Cache_Output class.

L

Log Class Log.
Log Function in class Log
Constructor

M

ModuleRequest Class ModuleRequest.
Class for handling requests of type 'module'.
ModuleRequest Function in class ModuleRequest
Modules Class Modules.
Modules Function in class Modules
Initializes class variables.

N

No Package specified Package

P

PathInfo Class PathInfo.
PathInfo Function in class PathInfo
Constructor. Parses $_SERVER['REQUEST_URI'] and stores the info.

R

Request Class Request.
Request Function in class Request
Initialize the class. Sets the $arrRequestVars attribute.
$Request Variable in Class Site
Top-level Request object.

S

SectionRequest Class SectionRequest.
This class handles requests made for navigating by Section.
SectionRequest Function in class SectionRequest
Init & call parent's constructor.
$Section Variable in Class SectionRequest
Stores the current Section object.
Section Class Section.
This is a skeleton class for a class that represents a record of type Section
Section Function in class Section
Constructor.
SITE_LIB_PATH.'/syntaxcms/SectionNavigatorOptimized.php' Included file in class Section
SectionNavigatorOptimized Class SectionNavigatorOptimized.
SectionNavigator Class SectionNavigator.
SectionNavigator Function in class SectionNavigator
Constructor. Can optionally take an initializing section object
Site Class Site.
Site Function in class Site
Constructor
StxUtilities Class StxUtilities.
Stx_Redirect Class Stx_Redirect.
Methods for working with a single redirect.
Stx_Redirects Function in class Stx_Redirect
Constructor
StxPrefs Class StxPrefs.
SyntaxCMS.Request Package
SyntaxCMS Package

U

$User Variable in Class Site
The pxdb_user object

_

_popSection Function in class SectionRequest
Pops & returns the hash for current session.
$_log Variable in Class Log
The array that stores the logged messages.
_setRequestType Function in class PathInfo
sets the request type
_setCurrentRequest Function in class PathInfo
Sets the current request
$_navPath Variable in Class Section
Public navigation path for the section
_setChildren Function in class SectionNavigator
Sets the pxdb_collection of children of the current section
_descend Function in class SectionNavigator
returns the value of descend, whether to descend into children or not
_addToStacks Function in class SectionNavigator
Add a pxdb_record of section type and pxdb_collection of children
_removeFromStacks Function in class SectionNavigator
Remove a pxdb_record object of type section and a pxdb_collection from the stacks.
_getFromStacks Function in class SectionNavigator
Get a pxdb_record object of type section and a pxdb_collection from the stacks.
$_showHiddenSections Variable in Class SectionNavigator
_link Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_link
_text Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_text()
_date Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_date()
_sql_date Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_sql_date()
_direc Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_get_sort_direction()

a

$arrSections Variable in Class SectionRequest
Path of information for each Section.
$arrFullPath Variable in Class SectionRequest
The path that includes hidden NAV_ROOT_EL section.
addVars Function in class Request
Adds an array of vars to the $arrRequestVars variable.
addTrailPoint Function in class Request
Appends a trail "point" (e.g. node) to the breadcrumb trail.
$arrPath Variable in Class Request
$arrPathDefaults Variable in Class Request
$arrRequestVars Variable in Class Request
$arrTrail Variable in Class Request
Hard-coded breadcrumb trail.
addModule Function in class Modules
Add a module to the current configuration.
addDependency Function in class Modules
Specify that one module depends on another.
aggregateAttribute Function in class Modules
Returns a list of all specified attribute for all modules.
addCapability Function in class Modules
Add a capability. This corresponds to the "Action" that can be performed

b

$blnParsed Variable in Class SectionRequest
Whether Section has been parsed.
$blnIncluded Variable in Class Request
blnIncluded
breadcrumb Function in class F1CMS
Builds the breadcrumb trail.
browseNav Function in class F1CMS
Build the navigation for "browsing" site content by topic / issue picklists.
buildBrowseArrays Function in class F1CMS
Build the navigation options for "browsing" site content by any number of picklists.
buildBrowseArray Function in class F1CMS
This method actually builds the array of option/values for a browseBy picklist

c

$currSection Variable in Class SectionRequest
The top section element.
countPathElements Function in class Request
Returns a count of the number of elements in the path
$children Variable in Class Request
Sub-requests
$children Variable in Class SectionNavigator
checkError Function in class Err
This is the public method CheckError, it uses
checkCache Function in class F1CMS
Examines pxdb_prefs table to see if any new content has been added. It checks this based on group -- which
callModule Function in class F1CMS
Alternative signature method for calling f1cms::module(). The function is a little
$currentRequest Variable in Class PathInfo
countChildren Function in class SectionNavigator
Returns the number of children at the current depth.
$childrenStack Variable in Class SectionNavigator
$cacheFlushed Variable in Class Site
Holds page-request wide status of cache flushing
createLink Function in class StxUtilities
Creates an a href tag given a url and its label
count Function in class Stx_Redirect
Returns the total number of rows found

d

delVar Function in class Request
Unsets a variable.
destroy Function in class Err
This is the public method Destroy, it removes
$descend Variable in Class SectionNavigator
$depth Variable in Class SectionNavigator
delete Function in class Stx_Redirect
Deletes the redirect from the database.

e

$errors Variable in Class Err
Stores errors.
entry Function in class Log
This method is a generalized logger, which can be sent any kind of
errorHandler Function in class Site
This is the error-handler function registered w/ PHP.
exists Function in class Stx_Redirect
Tests if a redirect under a root section already exists in the db

f

functionNav Function in class F1CMS
Build the navigation list for "functions" or "applications".
findModules Function in class Modules
Returns a list of modules that match certain criteria.
$fallbackProviders Variable in Class Modules
Modules that can provide functionality for other modules.
formatText Function in class StxUtilities
Formats text for display.
formatTimestamp Function in class StxUtilities
Formats a timestamp into a date.
formatDateString Function in class StxUtilities
Formats time string (such as a SQL formatted date) into a standard date format.
findLastDate Function in class StxUtilities
Finds the last date of a numerically given month and year
fetch_next Function in class Stx_Redirect
Returns the next object in the result set as an array
$facets Variable in Class StxPrefs
Facets holds an array describing fields that span content types
find_last_day Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_find_last_date()

g

getModule Function in class ModuleRequest
getAction Function in class ModuleRequest
Returns the action of current path.
getScript Function in class ModuleRequest
Gets the script that is supposed to handle the current request.
getScript Function in class SectionRequest
Returns the script to use for displaying the section.
getScript Function in class Request
An abstract method that you must override in your subclasses.
getBaseTrail Function in class ModuleRequest
Get breadcrumb trail for this module.
getBaseTrail Function in class SectionRequest
Build breadcrumb from NAV_ROOT_EL to current section, including all ancestors.
getTrail Function in class ModuleRequest
Gets the breadcrumb trail.
getTrail Function in class SectionRequest
Get array of current breadcrumb trail.
getTrail Function in class Request
An abstract method that you should override in your subclasses.
getPageTitle Function in class ModuleRequest
Returns the current page title.
getPageTitle Function in class SectionRequest
Returns the current page title.
getPageTitle Function in class Request
An abstract method that you may override in your subclasses.
getSectionID Function in class SectionRequest
Shortcut for getting curr section id.
getSectionDepth Function in class SectionRequest
Returns the depth of the current section.
getMetaKeywords Function in class SectionRequest
Returns the META-tag keywords.
getMetaKeywords Function in class Request
An abstract method that you must override in your subclasses.
getMetaKeywords Function in class Section
Get the value for field `meta_keywords`.
getMetaDescription Function in class SectionRequest
Returns the META-tag description.
getMetaDescription Function in class Request
An abstract method that you must override in your subclasses.
getMetaDescription Function in class Section
Get the value for field `meta_description`.
getPath Function in class Request
Gets a string representation of current path.
getPathElement Function in class Request
Gets a specified element from the path. (starting at 0).
getPathDefault Function in class Request
Gets a default rewrite path (if set). Use
getVar Function in class Request
Gets a value from request (by default $_REQUEST).
getVars Function in class Request
Gets all values from request (by default $_REQUEST).
getTrailStart Function in class Request
Gets the top-level section/node.
getSidebarScript Function in class Request
Returns the script to use for the sidebar.
getWindowTitle Function in class Request
A method for getting the window title.
getVarsAsQueryString Function in class Request
Returns a query string for all the variablies in the Request
getVarsAsHiddenInputs Function in class Request
Returns a query string for all the variablies in the Request
getMessage Function in class Err
This is the public method GetMessage, it returns
getCode Function in class Err
This is the public method GetCode, it returns
getType Function in class Err
This is the public method GetType, it returns
getSource Function in class Err
This is the public method GetSource, it returns
getFile Function in class Err
This is the public method GetFile, it returns
getLine Function in class Err
This is the public method GetLine, it returns
getContentUpdated Function in class F1CMS
Returns the timestamp stored under content_updated for a group
getDetailUrl Function in class F1CMS
Returns the url for the detail page of a record
getLog Function in class Log
Return the _log member variable.
getAttribute Function in class Modules
Get an attribute of a given module.
getGenericModule Function in class Modules
Gets the generic module if one has been established.
getFallbackProvider Function in class Modules
Returns the name fo a fallback provider for the requested action, if one exist.
getCapabilityProvider Function in class Modules
Returns the Module that provides a capability for a datatype.
$genericModule Variable in Class Modules
The name of a module to use as a generic module. (if requested
getRequestType Function in class PathInfo
Returns the request type
getCurrentRequest Function in class PathInfo
Returns the current request (section or module url_id)
getUrlId Function in class Section
Get the value for field `url_id`.
getCrumb Function in class Section
Get the value for field `crumb`.
getName Function in class Section
Get the value for field `name`.
getDescription Function in class Section
Get the value for field `description`.
getContent Function in class Section
Get the value for field `content`.
getGrouping Function in class Section
Get the value for field `grouping`.
getWeight Function in class Section
Get the value for field `weight`.
getTemplate Function in class Section
Get the value for field `url_path`.
getUrlPath Function in class Section
Get the value for field `url_path`.
getByUrlId Function in class Section
WARNING: This function no longer works, get rid of it in your code.
getByUrlPath Function in class Section
Get a section by its URL path
getNavPath Function in class Section
Returns the navigation path for the section
getNavPath Function in class SectionNavigator
Generates the URL to access the section.
getDepth Function in class SectionNavigator
Gets the current value of depth when using the getNextSection() method
getDescendantIds Function in class SectionNavigator
Returns an array of all children ids from the current section
getSectionTemplate Function in class StxUtilities
Takes a Section object and looks for its template. Put here
getImageLink Function in class StxUtilities
takes an image, finds the width and height, allows you to set a maximum width or height
getSortDirection Function in class StxUtilities
Calculates a sort direction for a field.
get_paged_collection Function in class Stx_Redirect
Returns an AdoDB recordset that is paged
get_last_page Function in class Stx_Redirect
Returns the last page number in a paged query
get_match Function in class Stx_Redirect
Sets the string used to match in the request uri
get_target_url Function in class Stx_Redirect
Gets the target URL
getFacets Function in class StxPrefs
Returns the global facet array.
get_section_template Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_get_section_template
get_image_link Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_get_image_link

h

http://'.$_SERVER['HTTP_HOST'].'/error.php Included file in class ModuleRequest
hasCapability Function in class Modules
Checks whether a module provides a specified capability.
hasChildren Function in class SectionNavigator
Returns a boolean, tests whether the current Section has children.
$hasChildren Variable in Class SectionNavigator
$homeSection Variable in Class SectionNavigator

i

isParentSection Function in class SectionRequest
Whether or not passed Section ID is in the path of sections.
isIncluded Function in class Request
Whether or not the current request is being included within another
isModule Function in class Modules
Checks to see if specified module is in directory.
isCurrentRequest Function in class PathInfo
Tests whether a given string is the current request (section or module)
isInPath Function in class PathInfo
Tests whether a url_id is in the current path or not. Used mainly with sections.
isParentOfCurrentRequest Function in class PathInfo
Tests if a url_id is the immediate parent of the current section
isLink Function in class Section
Returns whether a section is a link type or not
isAuthorized Function in class Section
Checks if the user can read this section AND all of its ancestors
isHomeSection Function in class SectionNavigator
Returns boolean whether the current (or passed) section is the home section
is_authorized Function in class SectionNavigator
Tests if the current section is readable
isCacheFlushed Function in class Site
Retuns whether the cache has been flushed of not. Defaults to false.
isValidEmail Function in class StxUtilities
**********************************************************************
isUrlExternal Function in class StxUtilities
Tells whether a link is external to the current site
$id Variable in Class Stx_Redirect
Database id
is_valid_email Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php

l

logError Function in class Err
Adds error to the log.
load Function in class Stx_Redirect
Attempts to load a redirect given its id

m

module Function in class F1CMS
Load content from a content "module".
$modules Variable in Class Modules
The registered modules.
makeUrlsLinks Function in class StxUtilities
$match Variable in Class Stx_Redirect
String to match for redirect

o

obfuscateAscii Function in class StxUtilities
Encodes ASCII text using numeric entities.
obfuscate_ascii Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Alias for stx_obfuscate_ascii()

p

parsePath Function in class SectionRequest
This parsePath implementation avoids the more expensive crazy left join that hans implemented.
$parent Variable in Class Request
Parent request
pager Function in class F1CMS
Display pagination.

q

$query Variable in Class Stx_Redirect
ADOdb recordset

r

removeModule Function in class Modules
Removes a module from the stack.
removeCapability Function in class Modules
Remove a capability.
regGenericModule Function in class Modules
Registers a module to use in case a request is made for a non-existant
regFallbackProvider Function in class Modules
Registers a module to use as a functionality provider for the
$requestType Variable in Class PathInfo
$root_section Variable in Class Stx_Redirect
The root section string (usually the NAV_ROOT_EL for the site) allows

s

setModule Function in class ModuleRequest
Sets the module (first part of path)
setAction Function in class ModuleRequest
Sets the module (second part of path)
setPath Function in class ModuleRequest
Overrides parent. Set the request path for the module to use
setPath Function in class Request
Set the request path to use (processes to account for default_path)
setPathElement Function in class Request
Sets a specified element of the path.
setPathDefault Function in class Request
Sets a default path to use for a module. Use
setVar Function in class Request
Sets a specific var in $arrRequestVars array.
setVars Function in class Request
Set the $arrRequestVars variable.
setTrail Function in class Request
Set the breadcrumb trail that will be appended to top-level node.
setTrailPoint Function in class Request
Manually sets a trail "point" (e.g. node) in the breadcrumb trail.
setSidebarScript Function in class Request
Sets the script to use for sidebar.
setPageTitle Function in class Request
A method to manually set PageTitle, for cases when it cannot be dynamically
setMetaKeywords Function in class Request
A method to manually set MetaKeywords, for cases when it cannot be dynamically
setMetaDescription Function in class Request
A method to manually set MetaDescription, for cases when it cannot be dynamically
$strPageTitle Variable in Class Request
Page Title
$strMetaKeywords Variable in Class Request
META Keywords
$strMetaDescription Variable in Class Request
META Description
$sidebarScript Variable in Class Request
Name of script to use for right side bar.
section Function in class F1CMS
Load content for a content "section"
sidebar Function in class F1CMS
Gets the content for the [right] sidebar.
smarterPager Function in class F1CMS
Alternative pagination. Not customizeable. Whether it's 'smarter'
start Function in class F1CMS_Cache
starts the output buffering and returns an empty string or returns the cached output from the cache.
setCapabilities Function in class Modules
Set the capabilities (or "what module provides") for specified module.
setAttribute Function in class Modules
Add / set an attribute for a module.
setShowHiddenSections Function in class SectionNavigatorOptimized
Controls wether we return hidden children sections
setShowHiddenSections Function in class SectionNavigator
Controls wether we return hidden children sections
setSection Function in class SectionNavigator
Set the section to be used, resets internal vars
setDescend Function in class SectionNavigator
Sets whether or not to descend into children of the current section.
$section Variable in Class SectionNavigator
$sectionStack Variable in Class SectionNavigator
setRequest Function in class Site
Sets the top-level Request object.
shutdown Function in class Site
This is the shutdown function registered w/ PHP.
setCache Function in class Site
Set the PEAR::Cache instance to use
setCacheFlushed Function in class Site
Set whether cache has been flushed in this request or not
set_root_section Function in class Stx_Redirect
Sets the root section to restrict redirects
set_id Function in class Stx_Redirect
Sets the id
set_match Function in class Stx_Redirect
Sets the string used to match in the request uri, the string
set_target_url Function in class Stx_Redirect
Sets the target URL
save Function in class Stx_Redirect
Saves a new redirect info to database.
setFacets Function in class StxPrefs
Sets the facet array to use globally.
stx_create_link Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Creates an a hreg tag given a url and its label
stx_format_text Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Formats text for display.
stx_format_timestamp Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Formats a timestamp into a date.
stx_format_date_string Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Formats time string (such as a SQL formatted date) into a standard date format.
stx_get_section_template Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Takes a Section object and looks for its template. Put here
stx_find_last_date Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Finds the last date of a numerically given month and year
stx_obfuscate_ascii Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Encodes ASCII text using numeric entities.
stx_get_image_link Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
takes an image, finds the width and height, allows you to set a maximum width or height
stx_get_sort_direction Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Calculates a sort direction for a field.
stx_is_url_external Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php
Tells whether a link is external to the current site
stx_truncate_to_sentence Function in module /home/ssmith/sandbox/syntax-cms/src/private/lib/syntaxcms/functions.lib.php

t

truncateToSentence Function in class StxUtilities
Truncates a block of text to the nearest end-of-sentence character after
$target_url Variable in Class Stx_Redirect
Target url (absolute or fully qualified w/http)

u

update Function in class Stx_Redirect
Saves redirect changes to the database
Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de