Abstract Class ModArticlesCategoryHelper

Description

Helper for mod_articles_category

  • abstract:

Located in /modules/mod_articles_category/helper.php (line 24)


	
			
Method Summary
 static void getList ( &$params)
 static void groupBy ( $list,  $fieldName,  $article_grouping_direction, [ $fieldNameToKeep = null])
 static void groupByDate ( $list, [ $type = 'year'],  $article_grouping_direction, [ $month_year_format = 'F Y'])
 static string truncate (string $html, [integer $maxLength = 0])
 static void _cleanIntrotext ( $introtext)
Methods
static getList (line 26)
  • access: public
static void getList ( &$params)
  • &$params
static groupBy (line 326)
  • access: public
static void groupBy ( $list,  $fieldName,  $article_grouping_direction, [ $fieldNameToKeep = null])
  • $list
  • $fieldName
  • $article_grouping_direction
  • $fieldNameToKeep
static groupByDate (line 363)
  • access: public
static void groupByDate ( $list, [ $type = 'year'],  $article_grouping_direction, [ $month_year_format = 'F Y'])
  • $list
  • $type
  • $article_grouping_direction
  • $month_year_format
static truncate (line 293)

Method to truncate introtext

The goal is to get the proper length plain text string with as much of the html intact as possible with all tags properly closed.

  • return: The truncated string
  • access: public
static string truncate (string $html, [integer $maxLength = 0])
  • string $html: The content of the introtext to be truncated
  • integer $maxLength: The maximum number of charactes to render
static _cleanIntrotext (line 271)
  • access: public
static void _cleanIntrotext ( $introtext)
  • $introtext

Documentation generated on Tue, 19 Nov 2013 15:04:33 +0100 by phpDocumentor 1.4.3