Procedural File: linkManager.php

Source Location: Program_Root/linkManager.php



Classes:

Page Details:

eDreamers Component - Link Builder

This component provides utility functions to build A href links from an array of references formatted as follows:

$LINKS = array(); $LINKS['referenceName']['label'] = 'The Webmaster'; $LINKS['referenceName']['address'] = 'mailto:webmaster@example.com';

The reference name can be whatever is giving a good representation of the link meaning/target. To insert the related link in a content page, the following code is used:

echo getLink( $LINKS, 'referenceName' );

Tags:





checkLinks

void checkLinks( mixed $arr_, [mixed $template = 'linkManager.tpl'])

[line 56]

Function - checkLinks

Parameters

[ Top ]

generateLinksFile

void generateLinksFile( mixed $arr_)

[line 96]

Parameters

[ Top ]

getLink

string getLink( array $arr_, string $str_name, [string $str_obj_ = null], [mixed $boo_newWindow = true])

[line 34]

Function - getLink

Generates a HTML A HREF link based on the information found in the references array and passed to the function

Tags:

  • return - the generated link as a string, needs to be sent to output by the calling script

Parameters

  • array $arr_ - a eDreamers compliant references array
  • string $str_name - the name of the reference to build the link to
  • string $str_obj_ - by default the link is built around the label but a string can be passed to the function in order to use any other string as link (other text, images, etc.)

[ Top ]


Documentation generated on Wed, 10 Dec 2003 21:45:25 +0100 by phpDocumentor 1.2.2