[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/modules/mod_articles_category/src/Helper/ -> ArticlesCategoryHelper.php (summary)

(no description)

Copyright: (C) 2010 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 496 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 6 functions

  getList()
  _cleanIntrotext()
  truncate()
  groupBy()
  groupByDate()
  groupByTags()

Functions
Functions that are not part of a class:

getList(&$params)   X-Ref
Get a list of articles from a specific category

param: \Joomla\Registry\Registry  &$params  object holding the models parameters
return: mixed

_cleanIntrotext($introtext)   X-Ref
Strips unnecessary tags from the introtext

param: string  $introtext  introtext to sanitize
return: mixed|string

truncate($html, $maxLength = 0)   X-Ref
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: string   $html       The content of the introtext to be truncated
param: integer  $maxLength  The maximum number of characters to render
return: string  The truncated string

groupBy($list, $fieldName, $direction, $fieldNameToKeep = null)   X-Ref
Groups items by field

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

groupByDate($list, $direction = 'ksort', $type = 'year', $monthYearFormat = 'F Y', $field = 'created')   X-Ref
Groups items by date

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

groupByTags($list, $direction = 'ksort')   X-Ref
Groups items by tags

param: array   $list       list of items
param: string  $direction  ordering direction
return: array



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer