SourceForge.net LogoPHPGallue
[ class tree: libgallue ] [ index: libgallue ] [ all elements ]

Class: GALPackage

Source Location: /libgallue/package.inc.php

Class Overview


Package class.


Variables

Constants

Methods


Child classes:


Class Details

[line 38]
Package class.

This class encapsulates a package of images used for im- and exporting.




[ Top ]


Class Variables

$categories = array()

[line 53]

Categories the images inside this package are member of.



Tags:

access:  protected

Type:   arary


[ Top ]

$films = array()

[line 63]

Films the images inside this package are member of.



Tags:

access:  protected

Type:   arary


[ Top ]

$glb =

[line 43]

The globak GALGallery object.



Tags:

access:  protected

Type:   GALGallery


[ Top ]

$groups = array()

[line 58]

Groups the images inside this package are member of.



Tags:

access:  protected

Type:   arary


[ Top ]

$images = array()

[line 48]

Images inside the package.



Tags:

access:  protected

Type:   array


[ Top ]

$masterItem =

[line 70]



Tags:

access:  protected

Type:   mixed


[ Top ]

$series = array()

[line 68]

Series the images inside this package are member of.



Tags:

access:  protected

Type:   arary


[ Top ]



Class Methods


constructor __construct [line 85]

GALPackage __construct( GALGallery $glb)

Initializes the package.

After construction the package doesn't contain anything. You can either load images from a master container via loadContainer() or from a package directory via import().




Parameters:

GALGallery   $glb  

[ Top ]

method downloadImages [line 273]

void downloadImages( $basepath)



Tags:

access:  protected


Overridden in child classes as:

GAL_HTMLExport::downloadImages()

Parameters:

   $basepath  

[ Top ]

method export [line 92]

void export( string $directory)

Saves all image data and writes the describing XML file.



Overridden in child classes as:

GAL_HTMLExport::export()

Parameters:

string   $directory   The directory the package is exported to.

[ Top ]

method exportXML [line 100]

void exportXML( string $dest)

Generate and write the describing XML file.



Tags:

access:  protected


Parameters:

string   $dest   The file name the XML file is saved to.

[ Top ]

method import [line 329]

void import( string $path, [int $readmode = GALBlob::COPY])

Imports a package directory.

This method loads the package's describing XML file and imports the image data as new images. Groups, films and series the imported images are always created newly, but if a category in the importing system exists that has exactly the same title as a category that is going to be imported, the existing category is used instead of creating a new category.




Parameters:

string   $path   The package's root directory.
int   $readmode   The way data are read when importing an image. Default is GALBlob::COPY.

[ Top ]

method loadContainer [line 230]

void loadContainer( $container)

Loads images from the specified conatiner.



Tags:

todo:  This method is slow and inefficient; it submits 4 queries per image, and one could reduce the overall number of queries to 6! (later)


Parameters:

GALTableRow   $container   GALContainer, GALGroup, GALFilm or GALSeries

[ Top ]


Class Constants

MAX_CATEGORIES =  10000

[line 76]

Max. number of categories loaded when looking for existing categories.


[ Top ]



Documentation generated on Wed, 16 Aug 2006 15:36:24 +0200 by phpDocumentor 1.3.0RC6