Documentation generator: JsDoc Toolkit 2.4.0
Template: Codeview 1.2
Generated on: 2011-5-27 22:23

Class Root

Class Summary
Constructor Attributes Constructor Name and Description
 
Root()
Antville’s root object is an extent of the Site prototype.
Field Summary
Field Attributes Field Name and Description
<private>  
 
 
 
api
 
 
 
 
 
 
 
 
 
 
 
 
<static> <constant>  
Root.VERSION
Fields borrowed from class Site:
$tags, archive, archiveMode, commentMode, created, creator, deleted, export_id, files, galleries, images, import_id, job, layout, locale, members, metadata, mode, modified, modifier, notificationMode, notified, pageMode, pageSize, polls, status, stories, tagline, tags, timeZone

Class Detail

Root()
Antville’s root object is an extent of the Site prototype.

Field Detail

<private> {Site[]} _children
{Admin} admin
{User[]} admins
{Api} api
{String} creationDelay
{String} creationScope
{String} notificationScope
{String} phaseOutGracePeriod
{String} phaseOutMode
{String} phaseOutNotificationPeriod
{String} probationPeriod
{String} quote
{String} replyTo
{Site[]} sites
{Site[]} updates
{User[]} users
<static> <constant> Root.VERSION

Method Detail

  • extractMessages(script, scanDirs, potFile)
    This method is called from the build script to extract gettext call strings from scripts and skins.
    Defined in: i18n.js.
    Parameters:
    {String} script
    {String} scanDirs
    {String} potFile
  • {Boolean} getCreationPermission()
    Returns:
    {Boolean}
  • {Object} getFormOptions(name)
    Parameters:
    {String} name
    Returns:
    {Object}
    See:
    Site#getFormOptions
  • {HopObject} getMacroHandler(name)
    Parameters:
    {String} name
    Returns:
    {HopObject}
    See:
    Site#getMacroHandler
  • {Boolean} getPermission(action)
    Parameters:
    {String} action
    Returns:
    {Boolean}
  • sitemap_xml_action()
    Sitemap for Google Webmaster Tools (Unfortunately, utterly useless.)
  • static_macro(param, name)
    Parameters:
    {Object} param
    {String} name