Docs For Class ItemFutureService

Description

Holds methods for working with Future Versions of Items.

version: $Id: ItemFutureService.php,v 1.10 2006/11/26 22:04:09 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

MasterItemType
   |
   --Itemtype
      |
      --ItemFutureService

Method Summary

ItemFutureService ItemFutureService ( $itemtype)

void createFutureVersion ( $itemid, $languageid, [ $userid = ''])

void deleteFutureRights (long $itemid)

boolean deleteFutureVersion ( $itemid, $languageid)

boolean deleteFutureVersions ( $itemid)

ItemFutureLanguageEnumeration getFutureLanguagesForItem ( $itemid)

FutureItem getFutureVersion ( $itemid, $languageid)

void hasFutureVersion ( $id, $languageid)

boolean publishFutureContent ( $itemid, $languageid)

void setFutureRights ( $itemid, $userid, $rightValue)

boolean updateFutureContent ( $itemid, $languageid, $content)

Methods

Constructor ItemFutureService (line 53)

Initalizes a new ItemFutureService for a special Itemtype.

ItemFutureService ItemFutureService ( $itemtype)

$itemtype

createFutureVersion (line 162)

Creates a Future Version of a Item, including a File and Database Version.

void createFutureVersion ( $itemid, $languageid, [ $userid = ''])

$itemid
$languageid
$userid

deleteFutureRights (line 337)

Delete all exisiting User access rights for an Item.

void deleteFutureRights (long $itemid)

long $itemid: itemid the ItemID to delete rights for

deleteFutureVersion (line 247)

Delete the specified Future Language Version.

This returns true on success or when there is simply no language version existing.

return: whether the call was successfull or not

boolean deleteFutureVersion ( $itemid, $languageid)

$itemid
$languageid

deleteFutureVersions (line 292)

Delete all Future Language Version for the given Item.

return: whether the call was successfull or not

boolean deleteFutureVersions ( $itemid)

$itemid

getFutureLanguagesForItem (line 311)

Returns an Enumeration of all Languages, the specified Item has Future Versions of.

return: all Future Languages for this Item

ItemFutureLanguageEnumeration getFutureLanguagesForItem ( $itemid)

$itemid

getFutureVersion (line 126)

Receives the Future Version of an Item.

return: the Future Item of the requested Item

FutureItem getFutureVersion ( $itemid, $languageid)

$itemid
$languageid

hasFutureVersion (line 145)

Returns if a Item has a Future Version.

void hasFutureVersion ( $id, $languageid)

$id
$languageid

publishFutureContent (line 224)

Publish the current Future Version and deletes it afterwards.

return: the Result of this call

boolean publishFutureContent ( $itemid, $languageid)

$itemid
$languageid

setFutureRights (line 320)

Set access rights for a single User.

void setFutureRights ( $itemid, $userid, $rightValue)

$itemid
$userid
$rightValue

updateFutureContent (line 193)

Updates the Future Content of an Item.

If the Item currently has no Future Content, it will be created!

return: whether the update could be performed or not

boolean updateFutureContent ( $itemid, $languageid, $content)

$itemid
$languageid
$content

Inherited Methods

Inherited From Itemtype

Itemtype::Itemtype()
Itemtype::getClass()
Itemtype::getClassName()
Itemtype::getCommand()
Itemtype::getDirectory()
Itemtype::getItemtypeID()
Itemtype::initItemtype()

Inherited From MasterItemType

MasterItemType::MasterItemType()
MasterItemType::countItemtypes()
MasterItemType::getClassForItemType()
MasterItemType::getClassNameForItemType()
MasterItemType::getCommandForItemType()
MasterItemType::getDirectoryForItemType()
MasterItemType::getItemTypeForCommand()
MasterItemType::getSelectColumns()