[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_actionlogs/src/Helper/ -> ActionlogsHelper.php (summary)

(no description)

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

Defines 1 class

ActionlogsHelper:: (7 methods):
  getCsvData()
  loadTranslationFiles()
  getLogContentTypeParams()
  getHumanReadableLogMessage()
  getContentTypeLink()
  loadActionLogPluginsLanguage()
  escapeCsvFormula()


Class: ActionlogsHelper  - X-Ref

Actionlogs component helper.

getCsvData($data)   X-Ref
Method to convert logs objects array to an iterable type for use with a CSV export

param: array|\Traversable  $data  The logs data objects to be exported
return: Generator

loadTranslationFiles($extension)   X-Ref
Load the translation files for an extension

param: string  $extension  Extension name
return: void

getLogContentTypeParams($context)   X-Ref
Get parameters to be

param: string  $context  The context of the content
return: mixed  An object contains content type parameters, or null if not found

getHumanReadableLogMessage($log, $generateLinks = true)   X-Ref
Get human readable log message for a User Action Log

param: \stdClass  $log            A User Action log message record
param: boolean    $generateLinks  Flag to disable link generation when creating a message
return: string

getContentTypeLink($component, $contentType, $id, $urlVar = 'id', $object = null)   X-Ref
Get link to an item of given content type

param: string     $component
param: string     $contentType
param: integer    $id
param: string     $urlVar
param: CMSObject  $object
return: string  Link to the content item

loadActionLogPluginsLanguage()   X-Ref
Load both enabled and disabled actionlog plugins language file.

It is used to make sure actions log is displayed properly instead of only language items displayed when a plugin is disabled.

return: void

escapeCsvFormula($value)   X-Ref
Escapes potential characters that start a formula in a CSV value to prevent injection attacks

param: mixed  $value  csv field value
return: mixed



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