_

__autoload() - Function in package Smutty

this function handles loading of smutty classes as and when they're needed, but is only supported by php5 >

_COOKIE() - Global in package Smutty

_GET() - Global in package Smutty

_POST() - Global in package Smutty

_REQUEST() - Global in package Smutty

A

action() - Method in class Smutty.Smutty_Controller

executes an action on the current controller

actionBefore() - Method in class Smutty.Smutty_Controller_Smutty

checks if the user is allowed to access to this section

add() - Method in class Smutty.Smutty_Model_Transaction

adds a model to the transaction

addError() - Method in class Smutty.Smutty_Controller

adds an error to this controller

addErrors() - Method in class Smutty.Smutty_Controller

adds errors to the current controller

addTest() - Method in class Smutty.Smutty_Test_Suite

adds a test to the suite

addWarning() - Method in class Smutty.Smutty_Error

adds a warning message

argv() - Global in package Smutty

arrayObjDiff() - Method in class Smutty.Smutty_Utils

computes the difference of arrays composed of objects

assertRegExps() - Method in class Smutty.Smutty_Test

this function tests an array of regular expressions against a string and asserts that they all match

C

camelize() - Method in class Smutty.Smutty_Inflector

Returns given word as CamelCased Converts a word like "send_email" to "SendEmail".

classify() - Method in class Smutty.Smutty_Inflector

Converts a table name to its class name according to rails naming conventions.

clearCacheAction() - Method in class Smutty.Smutty_Controller_Smutty

clears the smarty cache

completeRequest() - Method in class Smutty.Smutty_Main

this function does any cleanup/saving needed before the request is done.

connect() - Method in class Smutty.Smutty_Database_MySQL

connects to the database.

createController() - Method in class Smutty.Smutty_Smut

creates a controller

createGpgMessageBody() - Method in class Smutty.Smutty_Data

creates a signed message with the specified data.

createModel() - Method in class Smutty.Smutty_Smut

creates a model

createUser() - Method in class Smutty.Smutty_Session_Standard

checks to see if there's a 'User' class to use for the user object, otherwise it uses the standard user session object

D

data() - Method in class Smutty.Smutty_Data

returns a data object, which is a new instance of this object.

db() - Method in class Smutty.Smutty_Smut

performs an action on the database

delete() - Method in class Smutty.Smutty_Model

deletes the current model from the database

deleteWhere() - Method in class Smutty.Smutty_Model

this method allows deleting of multiple records

depend() - Method in class Smutty.Smutty_Template

this function loads another smarty plugin, specified by type (function/modifier/etc...) and name.

dispatch() - Method in class Smutty.Smutty_Router

dispatches the request.

display() - Method in class Smutty.Smutty_Template

displays a template.

E

enableTemplates() - Method in class Smutty.Smutty_Error

enables the use of smarty templates for error reporting purposes

encode() - Method in class Smutty.Smutty_JSON

encodes an arbitrary variable into JSON format

errorHandler() - Method in class Smutty.Smutty_Error

handles an error from php.

escape() - Method in class Smutty.Smutty_Database_MySQL

takes a string and escapes any characters in it that need to be for the current database

exists() - Method in class Smutty.Smutty_Model

determines if a record with the specified id currently exists in this models table

F

fatal() - Method in class Smutty.Smutty_Error

call this to raise a fatal error

fetch() - Method in class Smutty.Smutty_Database_Result

tries to fetch the next record as an array, false if there isn't anything to fetch

fetchAll() - Method in class Smutty.Smutty_Model

returns all the records for this model

fetchAssoc() - Method in class Smutty.Smutty_Database_Result

tries to fetch the next record as a hash, false if there isn't anything to fetch

fetchObject() - Method in class Smutty.Smutty_Database_Result

tries to fetch the next record as an object, false if there isn't anything to fetch

fill() - Method in class Smutty.Smutty_Model

this method tries to automatically fill a model with data that has been passed to the application.

find() - Method in class Smutty.Smutty_Model

this function allows searching for a record by it's unique id.

G

get() - Method in class Smutty.Smutty_Controller

returns the value of a template var

getActionName() - Method in class Smutty.Smutty_Router

returns the current action

getBaseUrl() - Method in class Smutty.Smutty_Utils

returns the base URL for the appliation

getControllerName() - Method in class Smutty.Smutty_Router

returns the name of the current controller

getCurrentDate() - Method in class Smutty.Smutty_Database_MySQL

returns the current date/time, formatted properly for the current database

getDate() - Method in class Smutty.Smutty_Data

returns the current date and time formatted as a string for use with the database

getDateFormat() - Method in class Smutty.Smutty_Database_MySQL

returns the date format for this db.

getDefaultActionName() - Method in class Smutty.Smutty_Router

returns the name of the default action

getDefaultControllerName() - Method in class Smutty.Smutty_Router

returns the name of the default controller

getError() - Method in class Smutty.Smutty_Database_MySQL

returns the last error to occur

getErrorReporting() - Method in class Smutty.Smutty_Error

returns the current level of error reporting

getErrors() - Method in class Smutty.Smutty_Model_Transaction

returns any errors found when trying to save the transaction

getFields() - Method in class Smutty.Smutty_Model

returns an array of this models fields and their types

getFieldsSql() - Method in class Smutty.Smutty_Database_MySQL

returns the sql used to eatract field information the resultset should have the fields: - name (field name) - type (field type) - nullable (yes/no string)

getFullUrl() - Method in class Smutty.Smutty_Utils

this function is just like getUrl(), only it includes the protocol://server:port part to.

getGetData() - Method in class Smutty.Smutty_Data

returns a data object for $_GET

getInsertId() - Method in class Smutty.Smutty_Database_MySQL

returns the auto generated id for the last record inserted.

getInstance() - Method in class Smutty.Smutty_Session

returns the instance of the session class

getInt() - Method in class Smutty.Smutty_Data

this method can be used staticly to validate data data as being an integer.

getJoinSql() - Method in class Smutty.Smutty_Model

returns the sql to do a join to the dot seperated list of models specified.

getKeyId() - Method in class Smutty.Smutty_GPG_ValidSignature

returns the keys id

getMessageBody() - Method in class Smutty.Smutty_GPG_SignedMessage

returns the body of the request

getMimeType() - Method in class Smutty.Smutty_Resource

returns the mime type for a specific file, determined by it's extension.

getName() - Method in class Smutty.Smutty_GPG_ValidSignature

returns the name associated with the sig

getPostData() - Method in class Smutty.Smutty_Data

returns a data object for $_POST

getPub() - Method in class Smutty.Smutty_GPG_Key

returns the pub data

getRelatedModels() - Method in class Smutty.Smutty_Controller_Smutty

fetches an array of model names which are "related" to the specifed model class

getResults() - Method in class Smutty.Smutty_Test_Reporter

returns the results after the tests have been run

getRouteSpec() - Method in class Smutty.Smutty_Router

this function searches the application config trying to match a route.

getServerData() - Method in class Smutty.Smutty_Data

returns a data object for $_SERVER

getSmuttyUrl() - Method in class Smutty.Smutty_Utils

this function returns the smutty url (ie.

getSub() - Method in class Smutty.Smutty_GPG_Key

returns the sub data

getText() - Method in class Smutty.Smutty_GPG_ValidSignature

returns the complete text of the verify result

getTotal() - Method in class Smutty.Smutty_Model

returns the total number of records for the model

getUid() - Method in class Smutty.Smutty_GPG_Key

returns the uid data

getUniqueId() - Method in class Smutty.Smutty_Utils

returns a unique 10 char id string

getUrl() - Method in class Smutty.Smutty_Utils

gets the url for a controller/action/etc...

getUser() - Method in class Smutty.Smutty_Session_Standard

this function tries to authenticate a user by standard username/password auth.

getWarnings() - Method in class Smutty.Smutty_Error

returns an array of warning messages that have been generated

getWildcardRegExp() - Method in class Smutty.Smutty_Config

converts a string into a regexp where wildcards (*'s) will be matched in it.

H

humanize() - Method in class Smutty.Smutty_Inflector

Returns a human-readable string from $word Returns a human-readable string from $word, by replacing underscores with a space, and by upper-casing the initial character by default.

I

import() - Method in class Smutty.Smutty_GPG

imports a public key into the keyring.

indexAction() - Method in class Smutty.Smutty_Controller_Smutty

index action, shows the home page

init() - Method in class Smutty.Smutty_Session

initializes the session object, setting things like cookie paths and handling a user

int() - Method in class Smutty.Smutty_Data

returns the value of the specifed variable as an integer (false if it's not valid)

intPad() - Method in class Smutty.Smutty_Data

returns an integer with a padded 0 if it is less than 10

isSigned() - Method in class Smutty.Smutty_Data

indicates if the data is PGP signed

isUsingTemplates() - Method in class Smutty.Smutty_Error

returns a boolean indicating if templates will be used when reporting an error

isValid() - Method in class Smutty.Smutty_Model_Transaction

checks if all the models in the transaction are valid

isValidControllerName() - Method in class Smutty.Smutty_Router

tests if a given controller name is valid

isValidHeader() - Method in class Smutty.Smutty_GPG_SignedMessage

checks a header is ok, ie it doesn't contain invalid chars, and is one of the ones defined in the spec.

isVerified() - Method in class Smutty.Smutty_Data

verifies the data's signature (if there is one).

L

listKeys() - Method in class Smutty.Smutty_GPG

lists the keys in the keyring.

loadClass() - Method in class Smutty.Smutty_Main

loads a class by name.

loadConfig() - Method in class Smutty.Smutty_Config

loads the config with data from the specified file.

loadDefaults() - Method in class Smutty.Smutty_Config

this function loads the default config files

loadLine() - Method in class Smutty.Smutty_Config

processes a single line of configuration info

loadModelClasses() - Method in class Smutty.Smutty_Main

loads any model classes the user has created

loginAction() - Method in class Smutty.Smutty_Controller_Smutty

draws the login page for the user depending on the current authentication method set up

logoutAction() - Method in class Smutty.Smutty_Controller_Smutty

logs the user out

M

modelBrowseAction() - Method in class Smutty.Smutty_Controller_Smutty

displays a listing of the models records (paged)

modelDeleteAction() - Method in class Smutty.Smutty_Controller_Smutty

deletes a model

modelEditAction() - Method in class Smutty.Smutty_Controller_Smutty

shows the page for editing/creating a new model

modelsAction() - Method in class Smutty.Smutty_Controller_Smutty

displays the current models

modelSaveAction() - Method in class Smutty.Smutty_Controller_Smutty

saves changes to a model

modelShowAction() - Method in class Smutty.Smutty_Controller_Smutty

displays a specific record for a model

N

name_value() - Method in class Smutty.Smutty_JSON

array-walking function for use in generating JSON-formatted name-value pairs

O

object() - Method in class Smutty.Smutty_Data

returns an object from the data

ordinalize() - Method in class Smutty.Smutty_Inflector

Converts number to its ordinal English form.

output() - Method in class Smutty.Smutty_Resource

this function can be used to output a resource to the user.

P

paintError() - Method in class Smutty.Smutty_Test_Reporter

an exception was raised

paintFail() - Method in class Smutty.Smutty_Test_Reporter

a test has failed

paintFooter() - Method in class Smutty.Smutty_Test_Reporter

the footer with the test results

pluralize() - Method in class Smutty.Smutty_Inflector

Pluralizes English nouns.

processMessage() - Method in class Smutty.Smutty_GPG_SignedMessage

processes a complete signed message block

processRoute() - Method in class Smutty.Smutty_Router

this function process the route definition and sets the values accordingly.

processSection() - Method in class Smutty.Smutty_GPG_SignedMessage

processes a section of a message (start tag, headers and body)

push() - Method in class Smutty.Smutty_Controller

this function pushes a value onto the named array, if the array doesn't exist then it's created.

Q

query() - Method in class Smutty.Smutty_Database_MySQL

executes a query on the database.

R

redirect() - Method in class Smutty.Smutty_Controller

redirects the user to the given url.

redirectJs() - Method in class Smutty.Smutty_Controller

this function takes the same arguments as the normal redirect function, but prints out javascript code to do the redirect itself.

redirectUrl() - Method in class Smutty.Smutty_Controller

redirects the user to the application url specified.

reduce_string() - Method in class Smutty.Smutty_JSON

reduce a string by removing leading and trailing comments and whitespace

resourceAction() - Method in class Smutty.Smutty_Controller_Smutty

displays one of the smutty resources

rssAction() - Method in class Smutty.Smutty_Controller_Smutty

this method provides built-in syndication for all models

run() - Method in class Smutty.Smutty_Test_Suite

runs the test suite

runTest() - Method in class Smutty.Smutty_Smut

runs a single test case

S

save() - Method in class Smutty.Smutty_Session

saves the data to the session object

script() - Method in class Smutty.Smutty_Database_MySQL

run an sql script against the database.

set() - Method in class Smutty.Smutty_Data

used to set values for this object

setActionName() - Method in class Smutty.Smutty_Router

sets the current action name

setErrorReporting() - Method in class Smutty.Smutty_Error

sets the level of error reporting

setLanguage() - Method in class Smutty.Smutty_Main

includes the correct langauge file

setup() - Method in class Smutty.Smutty_Smut

this action makes sure everything is set up for smutty

showStandard() - Method in class Smutty.Smutty_Error

shows an error message with standard output

showTemplate() - Method in class Smutty.Smutty_Error

shows an error message using smarty templates

singularize() - Method in class Smutty.Smutty_Inflector

Singularizes English nouns.

smarty_function_ajax_libs() - Function in package Smutty

smarty_function_button() - Function in package Smutty

smarty_function_checkbox() - Function in package Smutty

smarty_function_datefields() - Function in package Smutty

smarty_function_draggable() - Function in package Smutty

smarty_function_droppable() - Function in package Smutty

smarty_function_field() - Function in package Smutty

smarty_function_form() - Function in package Smutty

smarty_function_form_end() - Function in package Smutty

smarty_function_hidden() - Function in package Smutty

smarty_function_javascript() - Function in package Smutty

smarty_function_label() - Function in package Smutty

smarty_function_link() - Function in package Smutty

smarty_function_linkSelect() - Function in package Smutty

smarty_function_notice() - Function in package Smutty

smarty_function_paginate() - Function in package Smutty

smarty_function_password() - Function in package Smutty

smarty_function_rss() - Function in package Smutty

smarty_function_select() - Function in package Smutty

smarty_function_show_errors() - Function in package Smutty

smarty_function_smutty_link() - Function in package Smutty

smarty_function_submit() - Function in package Smutty

smarty_function_tabgroup() - Function in package Smutty

smarty_function_tabpage() - Function in package Smutty

smarty_function_tabpage_end() - Function in package Smutty

smarty_function_textarea() - Function in package Smutty

smarty_function_url() - Function in package Smutty

smarty_function_url_full() - Function in package Smutty

smarty_modifier_jsonize() - Function in package Smutty

smarty_modifier_plural() - Function in package Smutty

smarty_modifier_pluralize() - Function in package Smutty

smarty_prefilter_allow_assoc_attrs() - Function in package Smutty

this filter changes all assoc array style attributes to flat strings that can then be changed back by whichever plugin needs to use them.

smarty_prefilter_allow_assoc_attrs_replace() - Function in package Smutty

smut() - Global in package Smutty

Smutty_Config() - Class in package Smutty

this class creates allows access to config files in an easy way.

Smutty_Controller() - Class in package Smutty

this is the base class for all smutty controllers.

Smutty_Controller_Session() - Class in package Smutty

this class provides basic session handling functions that the user can extend so they don't have to write it themselves.

Smutty_Controller_Smutty() - Class in package Smutty

this is a controller for the built-in Smutty functionality like the model manager, clearing cache, etc...

Smutty_Data() - Class in package Smutty

this class controls access to GET, POST and SERVER data.

Smutty_Database() - Class in package Smutty

this is the base class which all database implementations need to extend and implement.

Smutty_Database_MySQL() - Class in package Smutty

an implementation of the database class for MySQL /

Smutty_Database_MySQL_Result() - Class in package Smutty

implementation of the Result class for mysql /

Smutty_Database_Result() - Class in package Smutty

this is an abstract class that needs to be implemented by each of the database drivers.

Smutty_Error() - Class in package Smutty

this class handles all exceptions and warnings generated by smutty.

smutty_error_handler() - Function in package Smutty

this is the handler for ALL errors generated when smutty is running.

smutty_function_ajax_libs() - Function in package Smutty

smutty_function_button() - Function in package Smutty

returns the html for a button

smutty_function_checkbox() - Function in package Smutty

returns the html for a form checkbox field

smutty_function_datefields() - Function in package Smutty

returns the html for a set of date field selects

smutty_function_datefields_getObjectRange() - Function in package Smutty

returns an array of objects with they're id and name attributes set to the specified range of numbers

smutty_function_draggable() - Function in package Smutty

returns the html for a draggable element

smutty_function_droppable() - Function in package Smutty

returns the html for a droppable element

smutty_function_field() - Function in package Smutty

returns the html for a form input field

smutty_function_form() - Function in package Smutty

returns the html for a form

smutty_function_form_end() - Function in package Smutty

smutty_function_hidden() - Function in package Smutty

returns the html for a hidden form field

smutty_function_javascript() - Function in package Smutty

smutty_function_label() - Function in package Smutty

returns the html for a form label

smutty_function_link() - Function in package Smutty

returns the html for an anchor element.

smutty_function_linkSelect() - Function in package Smutty

smutty_function_linkSelectText() - Function in package Smutty

smutty_function_notice() - Function in package Smutty

returns the html for displaying a brief notice on the page

smutty_function_paginate() - Function in package Smutty

returns the html for drawing page links

smutty_function_password() - Function in package Smutty

returns the html for a form password field

smutty_function_rss() - Function in package Smutty

returns the html to create a link to an automatcically generated smutty rss feed.

smutty_function_select() - Function in package Smutty

returns the html for a html select option

smutty_function_select_option() - Function in package Smutty

returns the html for a select option

smutty_function_show_errors() - Function in package Smutty

smutty_function_smutty_link() - Function in package Smutty

smutty_function_submit() - Function in package Smutty

returns the html for a form submit button

smutty_function_tabgroup() - Function in package Smutty

smutty_function_tabpage() - Function in package Smutty

smutty_function_tabpage_end() - Function in package Smutty

smutty_function_textarea() - Function in package Smutty

returns the html for a form textarea

smutty_function_url() - Function in package Smutty

smutty_function_url_full() - Function in package Smutty

Smutty_GPG() - Class in package Smutty

this class provides some functions for dealing with the gpg keyring (if there is one).

Smutty_GPG_Key() - Class in package Smutty

represents a PGP key stored in the keyring /

Smutty_GPG_PublicKey() - Class in package Smutty

represents a GPG public key /

Smutty_GPG_SignedMessage() - Class in package Smutty

represents a signed http post request, then provides some methods for finding out information about it /

Smutty_GPG_ValidSignature() - Class in package Smutty

represents a valid GPG signature, provides a few methods for extracting information about the sig.

Smutty_Inflector() - Class in package Smutty

Inflector for pluralize and singularize English nouns.

Smutty_JSON() - Class in package Smutty

Converts to and from JSON format.

Smutty_JSON_IN_ARR() - Global in package Smutty

Marker constant for Smutty_JSON::decode(), used to flag stack state /

Smutty_JSON_IN_CMT() - Global in package Smutty

Marker constant for Smutty_JSON::decode(), used to flag stack state /

Smutty_JSON_IN_OBJ() - Global in package Smutty

Marker constant for Smutty_JSON::decode(), used to flag stack state /

Smutty_JSON_IN_STR() - Global in package Smutty

Marker constant for Smutty_JSON::decode(), used to flag stack state /

Smutty_JSON_LOOSE_TYPE() - Global in package Smutty

Behavior switch for Smutty_JSON::decode() /

Smutty_JSON_SLICE() - Global in package Smutty

Marker constant for Smutty_JSON::decode(), used to flag stack state /

Smutty_JSON_SUPPRESS_ERRORS() - Global in package Smutty

Behavior switch for Smutty_JSON::decode() /

Smutty_Main() - Class in package Smutty

this is the main class in the application.

Smutty_Model() - Class in package Smutty

this is the base class for all Smutty models.

Smutty_Model_Transaction() - Class in package Smutty

this class allows models to be grouped together into a "transaction", which means you can deal with them as a single unit rather than saving/validating them all individually.

Smutty_Object() - Class in package Smutty

this is the root of all classes in smutty.

Smutty_Resource() - Class in package Smutty

this class handles access to "resources".

Smutty_Router() - Class in package Smutty

this class handles dispatching of requests via the correct controller and action.

Smutty_Session() - Class in package Smutty

this class handles sessions within smutty.

Smutty_Session_Abstract() - Class in package Smutty

this is the base class that Smutty authentication classes should implement.

Smutty_Session_Standard() - Class in package Smutty

a class for authenticating users by "standard" database user/pass authentication.

Smutty_Session_User() - Class in package Smutty

represents a user currently authenticated with Smutty.

Smutty_Smut() - Class in package Smutty

this class is the command line "smut" utility.

Smutty_Template() - Class in package Smutty

this is Smutty's customized subclass of a smarty template /

Smutty_Template_Smutty() - Class in package Smutty

this class is for templates used by the smutty framework itself.

Smutty_Test() - Class in package Smutty

Smutty's own subclass of the SimpleTest UnitTestCase.

Smutty_Test_AbstractReporter() - Class in package Smutty

this is an abstract class which smutty test reports must implement /

Smutty_Test_Mock() - Class in package Smutty

Smutty_Test_Reporter() - Class in package Smutty

handles the reporting of messages from user test cases /

Smutty_Test_Suite() - Class in package Smutty

Smutty's subclass of the SimpleTest TestSuite /

Smutty_Utils() - Class in package Smutty

this is a utility class that provides a number of static method for doing various things within Smutty /

smuttyView() - Method in class Smutty.Smutty_Controller

show the view file using the smutty template class

string() - Method in class Smutty.Smutty_Data

returns the value of the specifed variable as a string.

stripslashes_deep() - Function in package Smutty

strToHash() - Method in class Smutty.Smutty_Utils

this function turns a commer seperated string into a hash (associative array).

T

tableize() - Method in class Smutty.Smutty_Inflector

Converts a class name to its table name according to rails naming conventions.

testRunAction() - Method in class Smutty.Smutty_Controller_Smutty

runs a specific test case

testsAction() - Method in class Smutty.Smutty_Controller_Smutty

shows the tests that have been created for this application.

titleize() - Method in class Smutty.Smutty_Inflector

Converts an underscored or CamelCase word into a English sentence.

toArray() - Method in class Smutty.Smutty_Database_Result

returns the rows in this resultset as an array

tryAuth() - Method in class Smutty.Smutty_Session

tries to authenticate a user.

U

underscore() - Method in class Smutty.Smutty_Inflector

Converts a word "into_it_s_underscored_version" Convert any "CamelCased" or "ordinary Word" into an "underscored_word".

update() - Method in class Smutty.Smutty_Database_MySQL

executes an sql statement on the database and returns a boolean indicating if it went well or not

usage() - Method in class Smutty.Smutty_Smut

prints out a usage message for smut

utf162utf8() - Method in class Smutty.Smutty_JSON

convert a string from one UTF-16 char to one UTF-8 char Normally should be handled by mb_convert_encoding, but provides a slower PHP-only method for installations that lack the multibye string extension.

utf82utf16() - Method in class Smutty.Smutty_JSON

convert a string from one UTF-8 char to one UTF-16 char Normally should be handled by mb_convert_encoding, but provides a slower PHP-only method for installations that lack the multibye string extension.

V

v() - Function in package Smutty

a utility for safely extracting a value from an array

variablize() - Method in class Smutty.Smutty_Inflector

Same as camelize but first char is underscored Converts a word like "send_email" to "sendEmail".

verify() - Method in class Smutty.Smutty_GPG

verifies a signature with the keyring.

view() - Method in class Smutty.Smutty_Controller

show the specified file with the standard user template class.

W

w() - Function in package Smutty

safely gets a value from an array, and uses the default if it's not already set

warning() - Method in class Smutty.Smutty_Error

this method is used to indicate that something has gone wrong, but that it's not serious.

writeFile() - Method in class Smutty.Smutty_Smut

writes the given data to the specified file

This document was generated by PHPDoctor: The PHP Documentation Creator