Class microsite

Description

The Microsite Class

Encapsulates a microsite definition. Holds the meta-data associated with a microsite, and allows this data to be modified via a dedicated form/POSTprocess. Also allows the microsite to be requested for 'publishing' to the appropriate destination for microsites, depending on webserver requirements/configuration.

Located in /microsite-defs.php (line 47)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --microsite
Variable Summary
Method Summary
 microsite microsite ([string $name = ""])
 void delete ()
 boolean get ([mixed $name = ""])
 string html ()
 void initialise ()
 void publish ()
 void publish_request ()
 void remove_request ()
 void save ()
 void unpublish ()
Variables
mixed $catalogitems = array() (line 86)

Media items in this microsite (array)

mixed $css = "" (line 58)

The main stylesheet of the microsite

mixed $css_ie = "" (line 60)

The IE stylesheet of the microsite

mixed $css_ns = "" (line 62)

The Netscape stylesheet of the microsite

mixed $currently_installed = false (line 68)

Whether microsite is currently installed (built)

mixed $errmsgs = array() (line 95)

An array of error messages to report

mixed $exists = false (line 77)

Whether this microsite exists in database

mixed $formname = "" (line 92)

The name of our form

mixed $last_installed_ts (line 70)

When microsite was last installed (timestamp)

mixed $last_modified_ts (line 72)

When microsite was last modified (timestamp)

mixed $menu_id (line 56)

The ID of the microsite menu

mixed $microsite_desc = "" (line 52)

The description of the microsite

mixed $microsite_domain = "" (line 54)

The domain of the microsite

mixed $microsite_name = "" (line 50)

The name of the microsite

mixed $mode = "" (line 89)

mode of operation

mixed $pages = array() (line 83)

Pages in this microsite (array)

mixed $plugin_slots = MIN_PLUGIN_SLOTS (line 98)

Number of plugin slots we provide to edit page plugins

mixed $req_microsite_publish = false (line 64)

Whether microsite publish is being requested

mixed $req_microsite_remove = false (line 66)

Whether microsite removal is being requested

mixed $templates = array() (line 80)

Templates in this microsite (array)

Inherited Variables

Inherited from HTMLObject

HTMLObject::$accesskey
HTMLObject::$align
HTMLObject::$alt
HTMLObject::$bgcolor
HTMLObject::$bgurl
HTMLObject::$border
HTMLObject::$color
HTMLObject::$height
HTMLObject::$hspace
HTMLObject::$lang
HTMLObject::$langdir
HTMLObject::$linkover_text
HTMLObject::$name
HTMLObject::$onblur
HTMLObject::$onchange
HTMLObject::$onclick
HTMLObject::$ondblclick
HTMLObject::$onfocus
HTMLObject::$onkeydown
HTMLObject::$onkeypress
HTMLObject::$onkeyup
HTMLObject::$onload
HTMLObject::$onmousedown
HTMLObject::$onmousemove
HTMLObject::$onmouseout
HTMLObject::$onmouseover
HTMLObject::$onmouseup
HTMLObject::$onselect
HTMLObject::$size
HTMLObject::$src
HTMLObject::$tabindex
HTMLObject::$target
HTMLObject::$title
HTMLObject::$user_attributes
HTMLObject::$valign
HTMLObject::$vspace
HTMLObject::$width

Inherited from StylableObject

StylableObject::$class
StylableObject::$id
StylableObject::$style
Methods
Constructor microsite (line 105)

Constructor Create a new microsite instance.

microsite microsite ([string $name = ""])
  • string $name: The unique name/identity of the microsite.
delete (line 324)

Delete this microsite from the database. We do not rely on RI to delete all of the associated records, since the database in use might not support it.

void delete ()
get (line 147)

Get the microsite Retrieves the specified microsite from database. If it doesn't exist then we create a new one.

  • return: True if the record was acquired successfully
boolean get ([mixed $name = ""])
html (line 1465)

Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.

  • return: The HTML
string html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.
initialise (line 298)

Initialise this object to default values. Eg. this is done after a delete, so we don't see the deleted object data.

void initialise ()
publish (line 441)

Publish this microsite. We build the dir structures which actually

create this as an Axyl theme-website under the ./var directory, which is writeable to the webserver. If the microsite has been published already, then a symlink to our microsite will exist in the ./templates directory. If not, then we request it to be done by a cron-driven command-line Php script which has the required permissions.

void publish ()
publish_request (line 425)

Request publishing for this microsite. We just set a database flag so that the cron script will do the work.

void publish_request ()
remove_request (line 413)

Remove publishing for this microsite. We just set a database flag

so that the cron script will do the work. Note that this doesn't remove the actual definition of the microsite - just the bits and pieces (files) which are the physical instance of it, and which make it viewable to the internet.

void remove_request ()
save (line 247)

Save this microsite to the database. Create a new one if it doesn't already exist.

void save ()
unpublish (line 532)

Un-publish this microsite. This just removes the physical contents of the microsite which were created in the ./var area.

void unpublish ()

Inherited Methods

Inherited From HTMLObject

 HTMLObject::HTMLObject()
 HTMLObject::inherit_attributes()
 HTMLObject::setaccesskey()
 HTMLObject::setalign()
 HTMLObject::setalt()
 HTMLObject::setbackground()
 HTMLObject::setbgcolor()
 HTMLObject::setborder()
 HTMLObject::setcolor()
 HTMLObject::setheight()
 HTMLObject::sethspace()
 HTMLObject::setlang()
 HTMLObject::setlangdir()
 HTMLObject::setname()
 HTMLObject::setsize()
 HTMLObject::setsrc()
 HTMLObject::settabindex()
 HTMLObject::settarget()
 HTMLObject::settitle()
 HTMLObject::setvalign()
 HTMLObject::setvspace()
 HTMLObject::setwidth()
 HTMLObject::set_attribute()
 HTMLObject::set_linkover_text()
 HTMLObject::set_onblur()
 HTMLObject::set_onchange()
 HTMLObject::set_onclick()
 HTMLObject::set_ondblclick()
 HTMLObject::set_onfocus()
 HTMLObject::set_onkeydown()
 HTMLObject::set_onkeypress()
 HTMLObject::set_onkeyup()
 HTMLObject::set_onload()
 HTMLObject::set_onmousedown()
 HTMLObject::set_onmousemove()
 HTMLObject::set_onmouseout()
 HTMLObject::set_onmouseover()
 HTMLObject::set_onmouseup()
 HTMLObject::set_onselect()
 HTMLObject::set_tabindex()
 HTMLObject::taghtml()

Inherited From StylableObject

 StylableObject::StylableObject()
 StylableObject::clearstyle()
 StylableObject::setclass()
 StylableObject::setcss()
 StylableObject::setid()
 StylableObject::setstyle()

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3