Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None

Functions

  • awl_version
  • check_by_regex
  • dbg_error_log
  • dbg_log_array
  • define_byte_mappings
  • deprecated
  • fatal
  • force_utf8
  • get_fields
  • gzdecode
  • olson_from_tzstring
  • param_to_global
  • quoted_printable_encode
  • replace_uri_params
  • session_salted_md5
  • session_salted_sha1
  • session_simple_md5
  • session_validate_password
  • trace_bug
  • uuid
  • Overview
  • Package
  • Class

Package awl\Utilities

Functions summary
awl_version Return the AWL version
check_by_regex

Verify a value is OK by testing a regex against it. If it is an array apply it to each element in the array recursively. If it is an object we don't mess with it.

dbg_error_log

Writes a debug message into the error log using printf syntax. If the first parameter is "ERROR" then the message will always be logged. Otherwise, the first parameter is a "component" name, and will only be logged if $c->dbg["component"] is set to some non-null value.

dbg_log_array Function to dump an array to the error log, possibly recursively
define_byte_mappings
deprecated
fatal
force_utf8
get_fields Get the names of the fields for a particular table
gzdecode
olson_from_tzstring Try and extract something like "Pacific/Auckland" or "America/Indiana/Indianapolis" if possible.
param_to_global

Convert a parameter to a global. We first look in _POST and then in _GET, and if they passed in a bunch of valid characters, we will make sure the incoming is cleaned to only match that set.

quoted_printable_encode

Process a string to fit the requirements of RFC2045 section 6.7. Note that this works, but replaces more characters than the minimum set. For readability the spaces aren't encoded as =20 though.

replace_uri_params

Given a URL (presumably the current one) and a parameter, replace the value of parameter, extending the URL as necessary if the parameter is not already there.

session_salted_md5 Make a salted MD5 string, given a string and (possibly) a salt.
session_salted_sha1

Make a salted SHA1 string, given a string and (possibly) a salt. PHP5 only (although it could be made to work on PHP4 (@see http://www.openldap.org/faq/data/cache/347.html). The algorithm used here is compatible with OpenLDAP so passwords generated through this function should be able to be migrated to OpenLDAP by using the part following the second '*', i.e. the '{SSHA}....' part.

session_simple_md5 Make a plain MD5 hash of a string, identifying the type of hash it is
session_validate_password Checks what a user entered against the actual password on their account.
trace_bug Not as sever as a fatal() call, but we want to log and trace it
uuid Generates a Universally Unique IDentifier, version 4.
API documentation generated by ApiGen