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

Class: oops_smarty

Source Location: /modules/module_oops.php

Class oops_smarty

Class Overview
Method Summary
static void   array_assign()   Perform some standard operation on a array assignment to smarty
static void   default_assign()   Function to assign something to either a default smarty variable or to variable named by the 'assignto' param
static void   smarty_checked()   Return attribute checked if condition is met
static void   smarty_oops_paginate()   Smarty OOPs paginate call
static void   smarty_oops_search()   Search thru multiple objects

[ Top ]
Methods
static method array_assign  [line 459]

  static void array_assign( string $defname, &$params, &$smarty, &$_data, array $params, instance $smarty, mixed $data  )

Perform some standard operation on a array assignment to smarty

Params: random set to '1' to randomize the values in the array page/size paginate results, use page 'page' and page size 'size' (base 1) offset start returning data from offset 'offset' (base 0) limit limit to the number of results to 'limit'

assign name to assign data to, defaults to $defname

Parameters:
string   $defname:  default name for variable
array   $params:  all the params given
instance   $smarty:  the smarty instance
mixed   $data:  the data to assign
   &$params: 
   &$smarty: 
   &$_data: 

API Tags:
Access:  public


[ Top ]
static method default_assign  [line 435]

  static void default_assign( string $defname, &$params, &$smarty, &$data, array $params, instance $smarty, mixed $data  )

Function to assign something to either a default smarty variable or to variable named by the 'assignto' param

Params: assign name to assign data to, defaults to $defname

Parameters:
string   $defname:  default name for variable
array   $params:  all the params given
instance   $smarty:  the smarty instance
mixed   $data:  the data to assign
   &$params: 
   &$smarty: 
   &$data: 

API Tags:
Access:  public


[ Top ]
static method smarty_checked  [line 834]

  static void smarty_checked( $params, &$smarty, array $param, object $smarty  )

Return attribute checked if condition is met

<dl> <dt>get</dt><dd>GET argument to compare with</dd> <dt>post</dt><dd>POST argument to compare with</dd> <dt>getpost</dt><dd>GET or POST argument to compare with</dd> <dt>value</dt><dd>value to match</dd> </dl>

Parameters:
array   $param:  smarty tag params
object   $smarty:  smarty instance
   $params: 
   &$smarty: 

API Tags:
Access:  public


[ Top ]
static method smarty_oops_paginate  [line 749]

  static void smarty_oops_paginate( $params, &$smarty, array $param, object $smarty  )

Smarty OOPs paginate call

<dl> <dt>url</dt><dd>base URL (we will add pagenumber to the end)</dd> <dt>pages</dt><dd>show this number of pages</dd> <dt>left</dt><dd>show this number of pages to the left of the current one</dd> </dl>

Parameters:
array   $param:  smarty tag params
object   $smarty:  smarty instance
   $params: 
   &$smarty: 

API Tags:
Access:  public


[ Top ]
static method smarty_oops_search  [line 651]

  static void smarty_oops_search( $params, &$smarty, array $param, object $smarty  )

Search thru multiple objects

<dl> <dt>q</dt><dd>search string</dd> <dt>objects</dt><dd>objects to search thru</dd> <dt>sort_callback</dt><dd>sort callback function</dd> <dt>sort_by</dt><dd>sort results by</dd> <dt>assign_tagcloud</dt><dd>build a tagcloud from the results and assign it</dd> </dl>

Parameters:
array   $param:  smarty tag params
object   $smarty:  smarty instance
   $params: 
   &$smarty: 

API Tags:
Access:  public


[ Top ]

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