wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
Public Member Functions | List of all members
InternalLink Class Reference
Presentation

Public Member Functions

 makeLink ($oid)
 
 makeAnchorLink ($oid, $anchorOID, $anchorName=null)
 
 isLink ($link)
 
 getReferencedOID ($link)
 
 getAnchorOID ($link)
 
 getAnchorName ($link)
 

Detailed Description

InternalLink contains static methods for handling internal application links. These links are useful in an scenario, where an object represents a page and several subobjects represent page elements.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

See the license.txt file distributed with this work for additional information.

Id:
class.InternalLink.php 1462 2014-02-04 23:52:27Z iherwig
Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 30 of file class.InternalLink.php.

Member Function Documentation

InternalLink::makeLink (   $oid)

Make an internal link to an object

Parameters
oidThe id of the object to link to
Returns
The link

Definition at line 37 of file class.InternalLink.php.

Referenced by ResourceTreeController\getClickAction().

InternalLink::makeAnchorLink (   $oid,
  $anchorOID,
  $anchorName = null 
)

Make an internal link to an object

Parameters
oidThe object id of the object to link to
anchorOIDThe object id of the subobject to link to
anchorNameThe name inside the subobject to link to (null, if the object itself should be linked), [default: null]
Returns
The link

Definition at line 48 of file class.InternalLink.php.

InternalLink::isLink (   $link)

Test if a link is an internal link

Parameters
linkThe link to test
Returns
True/False wether the link is an internal link or not

Definition at line 61 of file class.InternalLink.php.

Referenced by DefaultControlRenderer\configure_linkbrowser(), and smarty_function_linktext().

InternalLink::getReferencedOID (   $link)

Get the oid of the referenced object

Parameters
linkThe link to process
Returns
The oid or null if no valid oid is referenced

Definition at line 70 of file class.InternalLink.php.

References PersistenceFacade\isValidOID().

Referenced by smarty_function_linktext().

+ Here is the call graph for this function:

InternalLink::getAnchorOID (   $link)

Get the oid of the referenced subobject if any

Parameters
linkThe link to process
Returns
The oid or null if no anchor is defined

Definition at line 86 of file class.InternalLink.php.

References PersistenceFacade\isValidOID().

+ Here is the call graph for this function:

InternalLink::getAnchorName (   $link)

Get the name of the anchor inside the referenced subobject if any

Parameters
linkThe link to process
Returns
The name or null if no anchor name is defined

Definition at line 102 of file class.InternalLink.php.

The documentation for this class was generated from the following file: