[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: ItemFutureService

Source Location: /CORE/system/classes/item/ItemFutureService.php

Class ItemFutureService

Class Overview

Holds methods for working with Future Versions of Items.

Located in /CORE/system/classes/item/ItemFutureService.php [line 43]

MasterItemType
   |
   --Itemtype
      |
      --ItemFutureService

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: ItemFutureService.php,v 1.11 2008/09/25 21:01:53 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Itemtype

Itemtype::Itemtype()

Itemtype::getClass()

Itemtype::getClassName()

Itemtype::getCommand()

Itemtype::getDirectory()

Itemtype::getItemtypeID()

Itemtype::initItemtype()

Inherited From MasterItemType

MasterItemType::MasterItemType()

Empty Constructor.

MasterItemType::countItemtypes()

Returns how many Itemtypes are known by the System.

MasterItemType::getClassForItemType()

Returns a new instance of the Class for the given Itentype ID.

MasterItemType::getClassNameForItemType()

Returns the Classname for the given Itentype ID.

MasterItemType::getCommandForItemType()

Return the Command for the given Itemtype ID.

MasterItemType::getDirectoryForItemType()

Return the Directory for the given Itemtype ID.

MasterItemType::getItemTypeForCommand()

Get the Itemtype ID for the given Command (or null).

MasterItemType::getSelectColumns()

Returns the Select Columns to be used for Item- and Treeselects.

[ Top ]

Method Summary

ItemFutureService	ItemFutureService()	Initalizes a new ItemFutureService for a special Itemtype.
void	createFutureVersion()	Creates a Future Version of a Item, including a File and Database Version.
void	deleteFutureRights()	Delete all exisiting User access rights for an Item.
boolean	deleteFutureVersion()	Delete the specified Future Language Version.
boolean	deleteFutureVersions()	Delete all Future Language Version for the given Item.
ItemFutureLanguageEnumeration	getFutureLanguagesForItem()	Returns an Enumeration of all Languages, the specified Item has Future Versions of.
FutureItem	getFutureVersion()	Receives the Future Version of an Item.
void	hasFutureVersion()	Returns if a Item has a Future Version.
boolean	publishFutureContent()	Publish the current Future Version and deletes it afterwards.
void	setFutureRights()	Set access rights for a single User.
boolean	updateFutureContent()	Updates the Future Content of an Item.

[ Top ]

Methods

Constructor ItemFutureService [line 53]

ItemFutureService ItemFutureService(

$itemtype 
)

Initalizes a new ItemFutureService for a special Itemtype.

Parameters:

$itemtype:

[ Top ]

createFutureVersion [line 161]

void createFutureVersion(

$itemid, 
$languageid, [
$userid = ''] 
)

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

Parameters:

	$itemid:
	$languageid:
	$userid:

[ Top ]

deleteFutureRights [line 336]

void deleteFutureRights(
long
$itemid 
)

Delete all exisiting User access rights for an Item.

Parameters:

long

$itemid:

itemid the ItemID to delete rights for

[ Top ]

deleteFutureVersion [line 246]

boolean deleteFutureVersion(

$itemid, 
$languageid 
)

Delete the specified Future Language Version.

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

Parameters:

	$itemid:
	$languageid:

API Tags:

Return:

whether the call was successfull or not

[ Top ]

deleteFutureVersions [line 291]

boolean deleteFutureVersions(

$itemid 
)

Delete all Future Language Version for the given Item.

Parameters:

$itemid:

API Tags:

Return:

whether the call was successfull or not

[ Top ]

getFutureLanguagesForItem [line 310]

ItemFutureLanguageEnumeration getFutureLanguagesForItem(

$itemid 
)

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

Parameters:

$itemid:

API Tags:

Return:

all Future Languages for this Item

[ Top ]

getFutureVersion [line 125]

FutureItem getFutureVersion(

$itemid, 
$languageid 
)

Receives the Future Version of an Item.

Parameters:

	$itemid:
	$languageid:

API Tags:

Return:

the Future Item of the requested Item

[ Top ]

hasFutureVersion [line 144]

void hasFutureVersion(

$id, 
$languageid 
)

Returns if a Item has a Future Version.

Parameters:

	$id:
	$languageid:

[ Top ]

publishFutureContent [line 223]

boolean publishFutureContent(

$itemid, 
$languageid 
)

Publish the current Future Version and deletes it afterwards.

Parameters:

	$itemid:
	$languageid:

API Tags:

Return:

the Result of this call

[ Top ]

setFutureRights [line 319]

void setFutureRights(

$itemid, 
$userid, 
$rightValue 
)

Set access rights for a single User.

Parameters:

	$itemid:
	$userid:
	$rightValue:

[ Top ]

updateFutureContent [line 192]

boolean updateFutureContent(

$itemid, 
$languageid, 
$content 
)

Updates the Future Content of an Item.

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

Parameters:

	$itemid:
	$languageid:
	$content:

API Tags:

Return:

whether the update could be performed or not

[ Top ]