Class site

(line 71)

Description

powlModule
   |
   --site

Located in File: /modules/cms/api/include.php

site - gets the website's pages


Class Variables

Summary:
mixed $contentUri
mixed $contentUris
mixed $language
mixed $layoutUri
mixed $siteModel
mixed $siteUri
mixed $sysUri

$contentShortUri = "content:" (line 83)

Data type : mixed

$contentShortUris = array("http://powl.sf.net/WCMS/Content/0.1#",
"bibtex:")
(line 86)

Data type : mixed

$contentUri = "http://powl.sf.net/WCMS/Content/0.1#" (line 74)

Data type : mixed

$contentUris = array("http://powl.sf.net/WCMS/Content/0.1#",
"http://purl.org/net/nknouf/ns/bibtex#")
(line 79)

Data type : mixed

$language (line 73)

Data type : mixed

$layoutShortUri = "layout:" (line 84)

Data type : mixed

$layoutUri = "http://powl.sf.net/WCMS/Layout/0.1#" (line 76)

Data type : mixed

$siteModel = "" (line 81)

Data type : mixed

$siteUri = "http://powl.sf.net/WCMS/AisSite/0.1#" (line 78)

Data type : mixed

$structureShortUri = "structure:" (line 85)

Data type : mixed

$structureUri = "http://powl.sf.net/WCMS/Structure/0.1#" (line 77)

Data type : mixed

$sysUri = "http://powl.sf.net/WCMS/SysOnt/0.1#" (line 75)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:
site site ( $lang)
String cleanLabels ( $tpl, String $tpl.)
void format_result_txt ( $txt,  $search_query)
String getClassTemplate ( $class, RDFSClass $class.)
String getContent (String $node)
String getNodeParent (String $node)
String, getPageType ( $node, String $node.)
String getParentForNewNode (String $node)
String getPositionForNewNode (String $node)
String getTemplateName ( $resourceName, [ $instanceOverview = 0], String $resourceName.)
void isContentInstance ( $uri)
Boolean isInstance ( $instanceName, String $instanceName.)
void isLinkableInstance ( $uri)
void isModule ( $uri)
String listNaviElements ([ $node = ''], String $node,)
array listSubPages ($pageParent $pageParent)
array listTopPages ()
void loadOnModel ( $model)
String renderClassInstancesList (array $instances)
String renderInstanceDetail (String $uri)
String renderInstanceOverview (String $node)
String renderInstanceProperty ( $propertyName,  $instanceProperties, String $propertyName., Array $instanceProperties.)
String renderPage (RDFSInstance $inst, [ $node = ''])
String renderProperty ( $propertyName,  $propertyValues, String $propertyName., Array $propertyValues.)
String renderResourceStandardProperties ( $instance,  $template, [ $link = ''], String $instance., String $template., String $link.)
String renderValueSelf ( $values, Array $values.)
void search ( $type,  $search_query)
$String stripChars ( $ustring, String $ustring.)

Constructor site (line 89)

site site( $lang)

Parameters

  • $lang:

Info

Method cleanLabels (line 832)

String cleanLabels( $tpl, String $tpl.)

Strip all labels from template. This function is needed for labels witohut values.

Parameters

  • String $tpl.:
  • $tpl:

Info

  • return - the html output.

Method format_result_txt (line 1102)

void format_result_txt( $txt, $search_query)

Parameters

  • $txt:
  • $search_query:

Info

Method getClassTemplate (line 794)

String getClassTemplate( $class, RDFSClass $class.)

Returns the template for a class template.

Parameters

Info

  • return - template code for a class template.

Method getContent (line 337)

String getContent( String $node)

Returns the generated html-code for a specified node.

Parameters

  • String $node:

Info

  • return - the html output for the page.

Method getNodeParent (line 243)

String getNodeParent( String $node)

Returns name of the parent element for a node.

Parameters

  • String $node:

Info

  • return - the parent node.

Method getPageType (line 272)

String, getPageType( $node, String $node.)

Returns the information for a node in the tree structure.

This funcion is necessary to check, if a node is an instance overview.

Parameters

  • String $node.:
  • $node:

Info

  • return - pagetype

Method getParentForNewNode (line 179)

String getParentForNewNode( String $node)

Returns the parent element for a new node in the tree.

return value will look like this: parent1|parent2 parent1= if new node will be a sibling, than the parent of $node will be parent parent2= if new node will be a child, than $node is parent

Parameters

  • String $node:

Info

  • return - possible parent elements for the node

Method getPositionForNewNode (line 202)

String getPositionForNewNode( String $node)

Returns the position for a new node in the tree.

return value will look like this: pos1|pos2 pos1= position for new node as sibling of $node pos2= position for new node as child of $node

Parameters

  • String $node:

Info

  • return - possible positions for the node

Method getTemplateName (line 745)

String getTemplateName( $resourceName, [ $instanceOverview = 0], String $resourceName.)

Returns the template name for a resource (class or property).

Parameters

  • String $resourceName.:
  • $resourceName:
  • $instanceOverview:

Info

  • return - name of the template

Method isContentInstance (line 1076)

void isContentInstance( $uri)

Parameters

  • $uri:

Info

Method isInstance (line 846)

Boolean isInstance( $instanceName, String $instanceName.)

This function checks if $instanceName is an instance in the content storage.

Parameters

  • String $instanceName.:
  • $instanceName:

Info

Method isLinkableInstance (line 1089)

void isLinkableInstance( $uri)

Parameters

  • $uri:

Info

Method isModule (line 1064)

void isModule( $uri)

Parameters

  • $uri:

Info

Method listNaviElements (line 304)

String listNaviElements( [ $node = ''], String $node,)

Returns an array of navigation elements for the website recursively.

Parameters

  • String $node,: if no node is given, then root will be used by default.
  • $node:

Info

  • return - the parent node.

Method listSubPages (line 132)

array listSubPages( $pageParent $pageParent)

Returns array of subnavi-elements with local names

Parameters

  • $pageParent $pageParent: - name of parent element

Info

Method listTopPages (line 109)

array listTopPages( )

Returns array of topnavi-elements with local names

Info

Method loadOnModel (line 99)

void loadOnModel( $model)

Parameters

  • $model:

Info

Method renderClassInstancesList (line 562)

String renderClassInstancesList( array $instances)

Returns the default html-code for an instance overview.

Parameters

  • array $instances: of RDFSInstances.

Info

  • return - the html output for the instances overview.

Method renderInstanceDetail (line 498)

String renderInstanceDetail( String $uri)

Returns the generated html-code for an instance detail page.

the instance is given by its uri.

Parameters

  • String $uri:

Info

  • return - the html output for the instance detail.

Method renderInstanceOverview (line 516)

String renderInstanceOverview( String $node)

Returns the generated html-code for an instance overview page.

Parameters

  • String $node:

Info

  • return - the html output for the instance overview.

Method renderInstanceProperty (line 638)

String renderInstanceProperty( $propertyName, $instanceProperties, String $propertyName., Array $instanceProperties.)

Returns the generated html output for a property template with its values.

The property has to be a reference on another content instance.

Parameters

  • String $propertyName.:
  • Array $instanceProperties.:
  • $propertyName:
  • $instanceProperties:

Info

  • return - html-code.

Method renderPage (line 396)

String renderPage( RDFSInstance $inst, [ $node = ''])

Returns the generated html-code for an instance.

Parameters

Info

  • return - the html output for the instance.

Method renderProperty (line 603)

String renderProperty( $propertyName, $propertyValues, String $propertyName., Array $propertyValues.)

Returns the generated html output for a property template with its values.

Parameters

  • String $propertyName.:
  • Array $propertyValues.:
  • $propertyName:
  • $propertyValues:

Info

  • return - html-code.

Method renderResourceStandardProperties (line 699)

String renderResourceStandardProperties( $instance, $template, [ $link = ''], String $instance., String $template., String $link.)

Parses the standard resource properties into a template if needed.

Standard properties are the following (Property: {Special-Marker})

Resource URI: {_ResourceUri_} - the uri of the resource Resource local name: {_ResourceLocalName_} - the local name of the resource Resource label name for a specified language: {_ResourceLabelName} - the label of the resource for the given language

Parameters

  • String $instance.:
  • String $template.:
  • String $link.: If resource should be linked in the page than giv url in $link.
  • $instance:
  • $template:
  • $link:

Info

  • return - html-code.

Method renderSearchResults (line 860)

String renderSearchResults( )

This function returns the generated html code for the search results.

Info

Method renderValueSelf (line 731)

String renderValueSelf( $values, Array $values.)

Returns the values as string.

Modify this function to control properties with more than 1 value.

Parameters

  • Array $values.:
  • $values:

Info

Method search (line 976)

void search( $type, $search_query)

Parameters

  • $type:
  • $search_query:

Info

Method stripChars (line 1135)

$String stripChars( $ustring, String $ustring.)

This function parses a given string for special chars.

Parameters

  • String $ustring.:
  • $ustring:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Tue, 07 Nov 2006 13:06:57 +0100 by phpDocumentor 1.3.0