Référence de la classe ModArticlesCategoryHelper

Fonctions membres publiques statiques
static	getList (&$params)
static	_cleanIntrotext ($introtext)
static	truncate ($html, $maxLength=0)
static	groupBy ($list, $fieldName, $direction, $fieldNameToKeep=null)
static	groupByDate ($list, $type='year', $direction='ksort', $monthYearFormat='F Y', $field='created')
static	groupByTags ($list, $direction='ksort')

Description détaillée

Helper for mod_articles_category

Depuis

1.6

Documentation des fonctions membres

_cleanIntrotext()

static _cleanIntrotext (   $introtext )

static

Strips unnecessary tags from the introtext

Paramètres

string

$introtext

introtext to sanitize

Renvoie

mixed|string

Depuis

1.6

getList()

static getList ( &  $params )

static

Get a list of articles from a specific category

Paramètres

\Joomla\Registry\Registry

&$params

object holding the models parameters

Renvoie

mixed

Depuis

1.6

Obsolète:

Catslug is deprecated, use catid instead. 4.0

Références $app, $article, $authorised, $category, $condition, $item, $items, $menu, $mode, $option, $ordering, $params, $view, elseif, ContentHelperRoute\getArticleRoute(), et ContentHelperRoute\getCategoryRoute().

groupBy()

static groupBy (   $list,   $fieldName,   $direction,   $fieldNameToKeep = null  )

static

Groups items by field

Paramètres

array	$list	list of items
string	$fieldName	name of field that is used for grouping
string	$direction	ordering direction
null	$fieldNameToKeep	field name to keep

Renvoie

array

Depuis

1.6

Références $direction, $item, $key, $list, et null.

groupByDate()

static groupByDate (   $list,   $type = 'year',   $direction = 'ksort',   $monthYearFormat = 'F Y',   $field = 'created'  )

static

Groups items by date

Paramètres

array	$list	list of items
string	$type	type of grouping
string	$direction	ordering direction
string	$monthYearFormat	date format to use
string	$field	date field to group by

Renvoie

array

Depuis

1.6

Références $date, $direction, $item, $items, $key, $list, et $type.

groupByTags()

static groupByTags (   $list,   $direction = 'ksort'  )

static

Groups items by tags

Paramètres

array	$list	list of items
string	$direction	ordering direction

Renvoie

array

Depuis

3.9.0

Références $direction, $item, et $list.

truncate()

static truncate (   $html,   $maxLength = 0  )

static

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.

Paramètres

string	$html	The content of the introtext to be truncated
integer	$maxLength	The maximum number of characters to render

Renvoie

string The truncated string

Depuis

1.6

Références $html.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• modules/mod_articles_category/helper.php