Packageindex Classtrees Modulegroups Elementlist Report XML Files

SyntaxCMS

Section

Section

private class Section extends pxdb_record

You can use this in place of using the pxdb_record class directly. Provided are some rough guesses of methods you might want. Customize & add as needed! Note that this class uses Camels Hump capitalization so that methods of this class can be easily distinguished from the all-lowercase methods of the parent classes. This class does not handle writing data to a record. You could add this if you wanted, but that is not part of the pxdb_record functionality -- that is handled by the pxdb_commit (and often pxdb_input for form building) classes. This class provides methods for accessing record values. You can use this class in conjunction with the pxdb_collection class by either 1) using the auto-generated SectionCollection class, which will return this object when you invoke the fetchRecord() method. or 2) specify this object when you fetch a record from pxdb_collection: while($rec = &$content->fetch_record('Section')) { print $rec->getName(); // e.g., not necessary a method of this class. }

Authors, Sandy Smith <ssmith@forumone.com>, Oscar Merida <omerida@forumone.com>
Version1.1

 

Public Method Summary

void Section(mixed $data)
Constructor.
object pxdb_record getByUrlPath(string $url_path, boolean $show_unapproved)
Get a section by its URL path
string getNavPath()
Returns the navigation path for the section
void &getAncestorCollection()
Uses SectionNavigator to return a pxdb_collection of the section's ancestors.
object [unknown] &getParentSection()
Returns the parent section object for the current section, if it has one.
boolean isLink()
Returns whether a section is a link type or not
boolean isAuthorized()
Checks if the user can read this section AND all of its ancestors

Private Method Summary

mixed getUrlId()
Get the value for field `url_id`.
mixed getCrumb()
Get the value for field `crumb`.
mixed getName()
Get the value for field `name`.
mixed getDescription()
Get the value for field `description`.
mixed getContent()
Get the value for field `content`.
mixed getGrouping()
Get the value for field `grouping`.
mixed getWeight()
Get the value for field `weight`.
mixed getMetaKeywords()
Get the value for field `meta_keywords`.
mixed getMetaDescription()
Get the value for field `meta_description`.
string getTemplate(string $field)
Get the value for field `url_path`.
string getUrlPath()
Get the value for field `url_path`.
void getByUrlId( $urlid, boolean $show_unapproved)
WARNING: This function no longer works, get rid of it in your code.

Private Field Summary

unknown $_navPath
Public navigation path for the section

Included files Summary, Type: require_once

SITE_LIB_PATH.'/syntaxcms/SectionNavigatorOptimized.php' Warning: documentation is missing.

Public Method Details

Section

public void Section(mixed $data)

  Calls parent constructor.

Parameter
mixed $data
Record ID or record row (array)
Returns void


getByUrlPath

public object pxdb_record getByUrlPath(string $url_path, boolean $show_unapproved)

 

Parameter
string $url_path
Full section path from top node to the section @pa
boolean $show_unapproved
Warning: documentation is missing.
Returns object pxdb_record

Author(s) Sandy Smith <ssmith@forumone.com>

getNavPath

public string getNavPath()

  Internally caches the result to avoid multiple calls to SectionNavigator

Returns string


&getAncestorCollection

public void &getAncestorCollection()

 

Returns void

Author(s) Oscar Merida <omerida@forumone.com>

&getParentSection

public object [unknown] &getParentSection()

 

Returns object [unknown]

Author(s)

isLink

public boolean isLink()

 

Returns boolean


isAuthorized

public boolean isAuthorized()

 

Returns boolean


Private Method Details

getUrlId

private mixed getUrlId()

 

Returns mixed

Value or array of values.


getCrumb

private mixed getCrumb()

 

Returns mixed

Value or array of values.


getName

private mixed getName()

 

Returns mixed

Value or array of values.


getDescription

private mixed getDescription()

 

Returns mixed

Value or array of values.


getContent

private mixed getContent()

 

Returns mixed

Value or array of values.


getGrouping

private mixed getGrouping()

 

Returns mixed

Value or array of values.


getWeight

private mixed getWeight()

 

Returns mixed

Value or array of values.


getMetaKeywords

private mixed getMetaKeywords()

 

Returns mixed

Value or array of values.


getMetaDescription

private mixed getMetaDescription()

 

Returns mixed

Value or array of values.


getTemplate

private string getTemplate(string $field)

 

Parameter
string $field
Warning: documentation is missing.
Returns string

Path from top-level Section to this one.


getUrlPath

private string getUrlPath()

 

Returns string

Path from top-level Section to this one.


getByUrlId

private void getByUrlId( $urlid, boolean $show_unapproved)

 

Parameter
$urlid
Warning: documentation is missing.
boolean $show_unapproved
Warning: documentation is missing.
Returns void


Private Field Details

$_navPath

private unknown $_navPath

>><<


Included Files, Type: require_once

SITE_LIB_PATH.'/syntaxcms/SectionNavigatorOptimized.php'

require_once( SITE_LIB_PATH.'/syntaxcms/SectionNavigatorOptimized.php' )



Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de