Class modPlaceholderTag

Description

Represents placeholder tags.

[[+placeholder_key]] Represents a placeholder with name placeholder_key.

Located in /model/modx/modparser.class.php (line 865)

modTag
   |
   --modPlaceholderTag
Method Summary
 modPlaceholderTag __construct (modX &$modx)
 void getContent ([ $options = array()])
 boolean isCacheable ()
 void process ([ $properties = null], [ $content = null])
 void setCacheable ([ $cacheable = true])
Variables
Methods
Constructor __construct (line 866)
modPlaceholderTag __construct (modX &$modx)

Redefinition of:
modTag::__construct()
getContent (line 899)

Get the raw source content of the field.

  • access: public
void getContent ([ $options = array()])
  • array $options

Redefinition of:
modTag::getContent()
Get the raw source content of the tag element.
isCacheable (line 915)

modPlaceholderTag instances cannot be cacheable.

  • return: Always returns false.
  • access: public
boolean isCacheable ()

Redefinition of:
modTag::isCacheable()
Indicates if the element is cacheable.
process (line 879)

Processes the modPlaceholderTag, recursively processing nested tags.

Tags in the properties of the tag itself, or the content returned by the tag element are processed. Non-cacheable nested tags are only processed if this tag element is also non-cacheable.

  • access: public
void process ([ $properties = null], [ $content = null])
  • $properties
  • $content

Redefinition of:
modTag::process()
Process the tag and return the result.
setCacheable (line 922)

modPlaceholderTag instances cannot be cacheable.

  • access: public
void setCacheable ([ $cacheable = true])
  • $cacheable

Redefinition of:
modTag::setCacheable()
Sets the runtime cacheability of the element.

Inherited Methods

Inherited From modTag

 modTag::__construct()
 modTag::cache()
 modTag::filterInput()
 modTag::filterOutput()
 modTag::get()
 modTag::getContent()
 modTag::getInputFilter()
 modTag::getOutputFilter()
 modTag::getProperties()
 modTag::getTag()
 modTag::getToken()
 modTag::isCacheable()
 modTag::process()
 modTag::set()
 modTag::setCacheable()
 modTag::setContent()
 modTag::setProperties()
 modTag::setTag()
 modTag::setToken()

Documentation generated on Fri, 17 Jun 2011 10:03:42 -0600 by phpDocumentor 1.4.3