Docs For Class Item

Class Item

Description

This is the Super Class for all Items!
Changes in here will be available in all implementing Items.

Currently used Text/Num/Date fields:
Item:

 getItemText('1') = getURL()
 getItemText('2') = getOriginalName()
 getItemNum('3')  = getFlag()
 getItemNum('4')  = getPosition()

Menu:

 getItemText('3') = getModulID()
 getItemText('4') = getLayoutName()
 getItemText('5') = HTML TAG stripped Text for SearchEngine

FutureItem:

 getItemNum('5')  = getAssignedUser()

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

MasterItemType
   |
   --Itemtype
      |
      --Item

Direct descendents

Class	Description
File	Class used for handling BIGACE "File" Items.
Image	This represents an Image Item.
Menu	Class used for handling Menus.

Method Summary

Item Item ( $itemtype, $id, [ $treetype = ITEM_LOAD_FULL], [ $languageID = ''])

boolean exists ()

String getCatchwords ()

ItemTreeWalker getChilds ([String $treetype = ITEM_LOAD_FULL])

mixed getContent ()

int getCreateByID ()

int getCreateDate ()

String getDescription ()

String getFullURL ()

int getID ()

void getItemDate ( $id)

void getItemNum ( $id)

void getItemText ( $id)

int getItemType ()

int getLanguageID ()

int getLastByID ()

int getLastDate ()

String getMimetype ()

String getName ()

String getOriginalName ()

int getParentID ()

int getPosition ()

long getSize ()

String getURL ()

long getValidFrom ()

long getValidTo ()

String getWorkflowName ()

boolean hasChilds ()

boolean isHidden ()

boolean isInTrash ()

int lastModified ()

String toString ()

Methods

Constructor Item (line 81)

Full construtor for fetching an specified Item from the Database.

You should probably use an concrete implementation of this class instead!?!

Item Item ( $itemtype, $id, [ $treetype = ITEM_LOAD_FULL], [ $languageID = ''])

$itemtype
$id
$treetype
$languageID

exists (line 444)

Checks whether this Item exists or not.

return: true if the Item exists, FALSE if it is corrupt or not existing

boolean exists ()

getCatchwords (line 205)

Returns the Item Catchwords.

Catchwords are a small (up to 255 Character) text value that are used within the Search!

return: the Items Cachtwords

String getCatchwords ()

getChilds (line 421)

Returns Language dependend Childs.

return: the Childs for this Item, in the Items Language

ItemTreeWalker getChilds ([String $treetype = ITEM_LOAD_FULL])

String $treetype: treetype the TreeType to use when fetching the Children

getContent (line 403)

Fetches the Content from the linked File.

return: the Content (might be BINARY, HTML or simply empty)

mixed getContent ()

getCreateByID (line 253)

Return the User ID this Item was created by.

return: the User ID of the Principal who created this Item

int getCreateByID ()

getCreateDate (line 261)

Returns the Timestamp, when the Item was created.

return: the creation timestamp

int getCreateDate ()

getDescription (line 196)

Returns the Item Description.

return: the Items description

String getDescription ()

getFullURL (line 334)

Return the absolute Path to the Items Content File.

return: the Items full name including directory

String getFullURL ()

getID (line 172)

Return the Item ID.

return: the Item ID

int getID ()

getItemDate (line 213)

Returns the desired ItemDate field.

access: protected

void getItemDate ( $id)

getItemNum (line 221)

Returns the desired ItemNum field.

access: protected

void getItemNum ( $id)

getItemText (line 229)

Returns the desired ItemText field.

access: protected

void getItemText ( $id)

getItemType (line 164)

Return the Itemtype ID.

return: the Itemtype ID

int getItemType ()

getLanguageID (line 237)

Return the Language ID of this Item.

return: the Items language ID

int getLanguageID ()

getLastByID (line 277)

Returns the ID of the last User that updated this Item.

return: the User ID of the last user

int getLastByID ()

getLastDate (line 269)

Returns the timestamp of the last changes on this Item (like Description or Content).

return: the timestamp of last changes

int getLastDate ()

getMimetype (line 180)

Return the Items Mimetype.

return: the Mimetype

String getMimetype ()

getName (line 188)

Fetch the Items Name.

return: the Items Name

String getName ()

getOriginalName (line 343)

Gets the original File Name. This MUST only work with uploaded Files.

Otherwise it depends on the User entrys.

return: the Original Item name

String getOriginalName ()

getParentID (line 245)

Return the Parents Item ID.

return: the ID of the Parent Item

int getParentID ()

getPosition (line 286)

Gets the Position of this Item.

The Position should be unique in this Tree.

return: the Position

int getPosition ()

getSize (line 390)

Gets the Size of the linked File.

return: the Filesize

long getSize ()

getURL (line 318)

Return the URL where this Items Content is stored.

return: the Items file name

String getURL ()

getValidFrom (line 374)

Returns the Timestamp, from when this Item will be valid (and therefor visible).

return: the Timestamp from when the Item will be valid

long getValidFrom ()

getValidTo (line 382)

Returns the Timestamp, till when this Item will be valid (and therefor visible).

return: the Timestamp till when the Item will be valid

long getValidTo ()

getWorkflowName (line 326)

Return the name of the configured Workflow.

return: the Workflow Name

String getWorkflowName ()

hasChilds (line 365)

Checks if the Item has childs in its own Language.

return: returns whether this Item has Childs or not

boolean hasChilds ()

isHidden (line 302)

See FLAG_HIDDEN.

return: whether this Item is hidden or not

boolean isHidden ()

isInTrash (line 310)

See FLAG_TRASH.

return: whether this Item is trashed or not

boolean isInTrash ()

lastModified (line 352)

Returns the last modified date of the File (filemtime).

Unlike

Item->getLastDate()

this only returns the last changes on the Items Content!

return: the last modified timestamp

int lastModified ()

toString (line 476)

Simple toString() implementation to make debugging easier.

return: a String representation of this Item, naming all important values

String toString ()

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()

Documentation generated by phpDocumentor 1.3.1