Docs For Class DimensionsPart

Description

The DimensionsPart attempts to extract height, width, and mime type info from a file, in an array similar to that returned from GetImageSize() method.

If the file is not an image and/or such information can not be determined, this part has a boolean value of false.

version: $Id: DimensionsPart.class.php,v 1.12 2007/09/04 20:25:44 adamfranco Exp $
license: GNU General Public License
copyright: Copyright ©2005, Middlebury College

Located in /harmoni/core/oki2/repository/File/Fields/DimensionsPart.class.php (line 26)

Part
   |
   --DimensionsPart

Direct descendents

Class	Description
ThumbnailDimensionsPart	The DimensionsPart attempts to extract height, width, and mime type info from a file, in an array similar to that returned from GetImageSize() method.

Variable Summary

mixed $_dimensions

mixed $_partStructure

mixed $_recordId

Method Summary

object DimensionsPart (object PartStructure $partStructure, object Id $recordId, object Properties $configuration, object Record $record, mixed $asset)

object Part createPart (mixed $partStructuretId, object mixed $value, object Id $partStructureId)

void deletePart (mixed $partId, object Id $partId )

object Id getId ()

object PartIterator getParts ()

object PartStructure getPartStructure ()

object mixed getValue ()

void updateValue (object mixed $value)

void _updateValue (array $value)

Variables

mixed $_dimensions (line 32)

mixed $_partStructure (line 31)

mixed $_recordId (line 30)

Methods

Constructor DimensionsPart (line 45)

Constructor

since: 10/17/05
access: public

object DimensionsPart (object PartStructure $partStructure, object Id $recordId, object Properties $configuration, object Record $record, mixed $asset)

object PartStructure $partStructure
object Id $recordId
object Properties $configuration
object Record $record

createPart (line 119)

Create a Part. Records are composed of Parts. Parts can also contain other Parts. Each Record is associated with a specific RecordStructure and each Part is associated with a specific PartStructure.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Part createPart (mixed $partStructuretId, object mixed $value, object Id $partStructureId)

object Id $partStructureId
object mixed $value: (original type: java.io.Serializable)

Redefinition of:

Part::createPart(): Create a Part. Records are composed of Parts. Parts can also contain other Parts. Each Record is associated with a specific RecordStructure and each Part is associated with a specific PartStructure.

deletePart (line 146)

Delete a Part and all its Parts.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deletePart (mixed $partId, object Id $partId )

object Id $partId

Redefinition of:

Part::deletePart(): Delete a Part and all its Parts.

getId (line 85)

Get the unique Id for this Part.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefinition of:

Part::getId(): Get the unique Id for this Part.

getParts (line 170)

Get all the Parts in this Part. Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PartIterator getParts ()

Redefinition of:

Part::getParts(): Get all the Parts in this Part. Iterators return a set, one at a time.

getPartStructure (line 327)

Get the PartStructure associated with this Part.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object PartStructure getPartStructure ()

Redefinition of:

Part::getPartStructure(): Get the PartStructure associated with this Part.

getValue (line 194)

Get the value for this Part.

return: (original type: java.io.Serializable)
access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object mixed getValue ()

Redefinition of:

Part::getValue(): Get the value for this Part.

updateValue (line 268)

Update the value for this Part.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateValue (object mixed $value)

object mixed $value: (original type: java.io.Serializable)

Redefinition of:

Part::updateValue(): Update the value for this Part.

_updateValue (line 339)

Allow the file record to update the fetch from its own queries

since: 11/17/05
access: private

void _updateValue (array $value)

array $value

Inherited Methods

Inherited From Part

Part::createPart()
Part::deletePart()
Part::getDisplayName()
Part::getId()
Part::getParts()
Part::getPartStructure()
Part::getValue()
Part::updateDisplayName()
Part::updateValue()