Class microsite_page

Description

Microsite Page - a container class.

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


	
			
Variable Summary
Method Summary
 microsite_page microsite_page ([integer $id = NEW_MICROSITE_PAGE], [string $microsite_name = ""], [string $title = ""], mixed $cache_seconds, [mixed $corepage = false], [boolean $homepage = false], [boolean $enabled = true], [string $label = ""], [mixed $mopid = ""], [integer $order = ""], [integer $template_id = ""], [integer $page_id = ""])
 void delete ()
 boolean get ([mixed $pageid = ""])
 void get_info ()
 void publishto (string $pubdir, string $realdir, integer $menu_id)
 boolean save ()
Variables
mixed $cache_seconds = 0 (line 2048)

How many seconds to cache this page

mixed $corepage = false (line 2050)

Whether this page is an Axyl core page

mixed $display_order = 999 (line 2058)

Order (for displaying menu lables)

mixed $enabled = true (line 2054)

Whether this page is to be published

mixed $menuoption_id (line 2070)

Menuoption ID - FK to ax_menuoption record

mixed $menuoption_label = "" (line 2056)

Label for menu option of this page

mixed $microsite_homepage = false (line 2052)

Whether this page is the microsite home page

mixed $microsite_name (line 2044)

Name of microsite this page is for

mixed $microsite_page_id (line 2042)

Unique microsite page ID

mixed $microsite_template_id (line 2062)

Microsite template ID (Fk)

mixed $page_id (line 2060)

Axyl sitepage ID (Fk)

mixed $page_path (line 2064)

Axyl sitepage page filepath

mixed $page_title = "" (line 2046)

Title of this page

mixed $template (line 2068)

The microsite template object applied to this page

Methods
Constructor microsite_page (line 2085)

Constructor

Create a new microsite_page

microsite_page microsite_page ([integer $id = NEW_MICROSITE_PAGE], [string $microsite_name = ""], [string $title = ""], mixed $cache_seconds, [mixed $corepage = false], [boolean $homepage = false], [boolean $enabled = true], [string $label = ""], [mixed $mopid = ""], [integer $order = ""], [integer $template_id = ""], [integer $page_id = ""])
  • integer $id: The unique microsite page ID
  • string $microsite_name: The name of the microsite this is for
  • string $title: The title of this page
  • boolean $homepage: True if this page is the site homepage (indexpage)
  • boolean $enabled: True if this page is ok to publish
  • string $label: The label to use for the menu option for this page
  • integer $order: The display order (for the menu option)
  • integer $template_id: The ID of the template record of this page (Fk)
  • integer $page_id: The ID of the Axyl sitepage record of this page (Fk)
delete (line 2202)

Delete this page from the database. We also delete all other records associated with this page, and do not rely on RI.

void delete ()
get (line 2125)

Get the microsite page details from the databse.

  • return: True if we successfully got the record
boolean get ([mixed $pageid = ""])
get_info (line 2164)

Get the associated details for this page, from the database. This includes the template(s) associated with the page, and also the menuoption_id linking to the associated menu option record.

void get_info ()
publishto (line 2316)

Publish this microsite page. We create a sitepage record, and save a FK to it, create a menuoption for the page and FK to that, and we create a physical page from the microsite template.

void publishto (string $pubdir, string $realdir, integer $menu_id)
  • string $pubdir: Web-relative path to dir to save the page file
  • string $realdir: Path for menuoption - for page access when published
  • integer $menu_id: ID of the menu to create menuoptions for
save (line 2258)

Update or create the microsite page. Also saves the template data associated with it.

  • return: True if we successfully saved the record
boolean save ()

Documentation generated by phpDocumentor 1.3.0RC3