phpDocumentor Permalinks
Classes
[ class tree: Permalinks ] [ index: Permalinks ] [ all elements ]

Class: PermalinksMapHelper

Source Location: /modules/permalinks/classes/PermalinksMapHelper.class

Class PermalinksMapHelper

Class Overview

Utility functions useful in managing Permalinks.

Located in /modules/permalinks/classes/PermalinksMapHelper.class [line 35]



		
		
		
		

Methods

[ Top ]
Method Summary
GalleryStatus   createAlias()   Create an alias
GalleryStatus   deleteAlias()   Delete an alias
array   fetchAliasesForItem()   Return the aliases defined for a given item
array   fetchItemIdForAlias()   Return the item id the alias name refers to, if any

[ Top ]
Methods
createAlias  [line 88]

  GalleryStatus createAlias( string $aliasName, int $itemId  )

Create an alias

Parameters:
string   $aliasName: 
int   $itemId: 

API Tags:
Return:  a status code


[ Top ]
deleteAlias  [line 115]

  GalleryStatus deleteAlias( int $aliasName  )

Delete an alias

Parameters:
int   $aliasName: 

API Tags:
Return:  a status code


[ Top ]
fetchAliasesForItem  [line 44]

  array fetchAliasesForItem( [int $itemId = null]  )

Return the aliases defined for a given item

Parameters:
int   $itemId:  (optional) item id or null for all aliases

API Tags:
Return:  GalleryStatus a status code array of aliase names


[ Top ]
fetchItemIdForAlias  [line 66]

  array fetchItemIdForAlias( string $aliasName  )

Return the item id the alias name refers to, if any

Parameters:
string   $aliasName: 

API Tags:
Return:  GalleryStatus a status code int item id


[ Top ]

Documentation generated on Sat, 21 Nov 2009 05:17:55 -0800 by phpDocumentor 1.3.0RC6