phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Class: oops_common

Source Location: /modules/module_oops.php

Class oops_common

Method Summary
static string   gravatar()   Gravatar call
static string   parse_url_macros()   Parse URL macros
static string   pluralize()   Pluralize an English singular
static void   redirect()   Redirect to another page
static void   smarty_oops_redirect()   Redirect to another page
static string   __parse_url_macros_callback()   (internal) Callback for URL macro for the parse_url_macros method

[ Top ]
Methods
static method gravatar  [line 213]

  static string gravatar( string $email, string $size  )

Gravatar call

Parameters:
string   $email:  email address for gravatar
string   $size:  size of the gravatar to return

API Tags:
Return:  image url of the gravatar
Access:  public


[ Top ]
static method parse_url_macros  [line 200]

  static string parse_url_macros( string $url  )

Parse URL macros

Parameters:
string   $url:  url url to parse macros in

API Tags:
Return:  the new url
Access:  public


[ Top ]
static method pluralize  [line 145]

  static string pluralize( string $name  )

Pluralize an English singular

Not very sophisticated but it works..

Parameters:
string   $name:  singular word

API Tags:
Return:  plural version of the word
Access:  public


[ Top ]
static method redirect  [line 160]

  static void redirect( string $url, [ $status = 302]  )

Redirect to another page

This method calls exit() aswell.

Parameters:
string   $url:  url to redirect to
   $status: 

API Tags:
Access:  public


[ Top ]
static method smarty_oops_redirect  [line 227]

  static void smarty_oops_redirect( $params, &$smarty  )

Redirect to another page

<dl> <dt>url</dt><dd>URL to redirect to, defaults to /</dd> <dt>status</dt><dd>Status to redirect with, defaults to 302</dd> </dl>

Parameters:
   $params: 
   &$smarty: 

API Tags:
Access:  public


[ Top ]
static method __parse_url_macros_callback  [line 172]

  static string __parse_url_macros_callback( array $matches  )

(internal) Callback for URL macro for the parse_url_macros method

Parameters:
array   $matches:  regex matches

API Tags:
Return:  macro replacement value
Access:  public


[ Top ]

Documentation generated on Thu, 17 May 2012 01:07:19 +0200 by phpDocumentor 1.4.3