Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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, $article_grouping_direction, $fieldNameToKeep=null)
 
static groupByDate ($list, $type='year', $article_grouping_direction, $month_year_format='F Y')
 

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$introtextintrotext 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&$paramsobject 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(), ContentHelperRoute\getCategoryRoute(), et true.

◆ groupBy()

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

Groups items by field

Paramètres
array$listlist of items
string$fieldNamename of field that is used for grouping
string$article_grouping_directionordering direction
null$fieldNameToKeepfield name to keep
Renvoie
array
Depuis
1.6

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

◆ groupByDate()

static groupByDate (   $list,
  $type = 'year',
  $article_grouping_direction,
  $month_year_format = 'F Y' 
)
static

Groups items by date

Paramètres
array$listlist of items
string$typetype of grouping
string$article_grouping_directionordering direction
string$month_year_formatdate format to use
Renvoie
array
Depuis
1.6

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

◆ 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$htmlThe content of the introtext to be truncated
integer$maxLengthThe maximum number of charactes 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 :