Class plgContentEmailcloak

Description

Email cloack plugin class.

Located in /plugins/content/emailcloak/emailcloak.php (line 16)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgContentEmailcloak
Method Summary
boolean onContentPrepare (string $context, mixed &$row, array &$params, [int $page = 0])
boolean _cloak (string &$text, array &$params)
string _getPattern (string $link, string $text)
Variables

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
onContentPrepare (line 27)

Plugin that cloaks all emails in content from spambots via Javascript.

  • return: True on success.
  • access: public
boolean onContentPrepare (string $context, mixed &$row, array &$params, [int $page = 0])
  • string $context: The context of the content being passed to the plugin.
  • mixed &$row: An object with a "text" property or the string to be cloaked.
  • array &$params: Additional parameters. See {@see plgEmailCloak()}.
  • int $page: Optional page number. Unused. Defaults to zero.
_cloak (line 61)

Cloak all emails in text from spambots via Javascript.

  • return: True on success.
  • access: protected
boolean _cloak (string &$text, array &$params)
  • string &$text: The string to be cloaked.
  • array &$params: Additional parameters. Parameter "mode" (integer, default 1) replaces addresses with "mailto:" links if nonzero.
_getPattern (line 47)

Genarate a search pattern based on link and text.

  • return: A regular expression that matches a link containing the parameters.
  • access: protected
string _getPattern (string $link, string $text)
  • string $link: The target of an email link.
  • string $text: The text enclosed by the link.

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:54:27 -0500 by phpDocumentor 1.4.4