Docs For Class RepositoryImporter

Class RepositoryImporter

Description

#insertion#

version: $Id: RepositoryImporter.class.php,v 1.33 2007/09/19 14:04:48 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 7/20/05

Located in /polyphony/main/library/RepositoryImporter/RepositoryImporter.class.php (line 27)

Direct descendents

Class	Description
ExifRepositoryImporter	<##>
FilesOnlyRepositoryImporter	<##>
TabRepositoryImporter	<##>
	<##>

Method Summary

object RepositoryImporter (String $filepath, object Id $repositoryId, [mixed $dieOnError = false])

void addError (String $error)

void addGoodAssetId (mixed $goodAssetId, String $error)

boolean assetBuildingIteration (mixed $assetIterator, mixed $parent, mixed $buildOrderedSet)

asset buildAsset (array $info, array 1)

void decompress ()

iterator getAllAssetsInfoIterator (mixed $assetIterator)

bool getBuildOrderedSet (obj $asset)

array getErrors ()

array getGoodAssetIds ()

object mixed getPartObject (Id $structureId, Id $partStructureId, String $part)

boolean hasAssets ()

boolean hasErrors ()

obj import ([String $decompress = true], object Id 1)

false matchPartStructures (mixed $schema, mixed $partArray)

false matchSchema (mixed $schema, mixed $repository)

void parse ()

void printErrorMessages (array $goodAssetIds)

void printGoodAssetIds (array $goodAssetIds)

void setParent (object Asset $asset)

Methods

Constructor RepositoryImporter (line 39)

Constructor

since: 7/20/05
access: public

object RepositoryImporter (String $filepath, object Id $repositoryId, [mixed $dieOnError = false])

object Id $repositoryId
String $filepath: filename

addError (line 467)

adds an error to the error array

since: 7/26/05
access: public

void addError (String $error)

String $error

addGoodAssetId (line 501)

adds an error to the error array

since: 7/26/05
access: public

void addGoodAssetId (mixed $goodAssetId, String $error)

String $error

assetBuildingIteration (line 146)

Iterates through the building of the assets

since: 7/20/05
access: public

boolean assetBuildingIteration (mixed $assetIterator, mixed $parent, mixed $buildOrderedSet)

buildAsset (line 258)

builds asset in repository from assetinfo and records from recordlist

return: or false on fatal error
since: 7/18/05
access: public

asset buildAsset (array $info, array 1)

array 1: recordList
array $info: assetInfo

decompress (line 89)

since: 7/20/05
access: public

void decompress ()

getAllAssetsInfoIterator (line 182)

Iterates through the assets and gathers all required information for creating assets

return: or false on fatal error
since: 7/20/05
access: public

iterator getAllAssetsInfoIterator (mixed $assetIterator)

getBuildOrderedSet (line 408)

Gets whether or not to build an ordered list

Should be overridden in subclasses that allow child assets

since: 8/16/05

bool getBuildOrderedSet (obj $asset)

obj $asset

Redefined in descendants as:

: get whether or not to build ordered set from children

getErrors (line 445)

gets error array

since: 7/26/05
access: public

array getErrors ()

getGoodAssetIds (line 478)

gets created assset ids array

since: 7/26/05
access: public

array getGoodAssetIds ()

getPartObject (line 359)

creates appropriate object from given ids

since: 7/21/05
access: public

object mixed getPartObject (Id $structureId, Id $partStructureId, String $part)

Id $structureId
Id $partStructureId
String $part

hasAssets (line 489)

checks for built Assets

since: 7/26/05
access: public

boolean hasAssets ()

hasErrors (line 456)

checks for errors

since: 7/26/05
access: public

boolean hasErrors ()

import (line 69)

since: 7/20/05
access: public

obj import ([String $decompress = true], object Id 1)

object Id 1: repositoryId
String $decompress: filename

matchPartStructures (line 229)

tries to match the given array with partstructure in the given structure

return: if not matched and an array of partstructure ids
since: 7/18/05
access: public

false matchPartStructures (mixed $schema, mixed $partArray)

matchSchema (line 208)

tries to match given string to a schema with the same name.

return: if no schema is matched, and the schemaId if matched
since: 7/18/05
access: public

false matchSchema (mixed $schema, mixed $repository)

parse (line 128)

Parses the archive file according to its type i.e. properly

since: 7/20/05
access: public

void parse ()

printErrorMessages (line 419)

Print the AssetIds for Assets created properly by the importer

since: 7/29/05

void printErrorMessages (array $goodAssetIds)

array $goodAssetIds

printGoodAssetIds (line 432)

Print the AssetIds for Assets created properly by the importer

since: 7/29/05

void printGoodAssetIds (array $goodAssetIds)

array $goodAssetIds

setParent (line 56)

Set An asset that will the parent of imported assets

since: 4/2/07
access: public

void setParent (object Asset $asset)

object Asset $asset

Documentation generated on Wed, 19 Sep 2007 10:25:59 -0400 by phpDocumentor 1.3.0RC3