OfficeDoc Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeDoc class implements support for the Open XML Packaging Format used in Office 2007 documents.

Class Name

IPWorksZip_OfficeDoc

Procedural Interface

 ipworkszip_officedoc_open();
 ipworkszip_officedoc_close($res);
 ipworkszip_officedoc_register_callback($res, $id, $function);
 ipworkszip_officedoc_get_last_error($res);
 ipworkszip_officedoc_get_last_error_code($res);
 ipworkszip_officedoc_set($res, $id, $index, $value);
 ipworkszip_officedoc_get($res, $id, $index);
 ipworkszip_officedoc_do_close($res);
 ipworkszip_officedoc_do_config($res, $configurationstring);
 ipworkszip_officedoc_do_extractpart($res);
 ipworkszip_officedoc_do_findpartbytype($res, $typeuri);
 ipworkszip_officedoc_do_getpropertyvalue($res, $propname, $propnamespace);
 ipworkszip_officedoc_do_listparts($res);
 ipworkszip_officedoc_do_open($res);
 ipworkszip_officedoc_do_parsepart($res);
 ipworkszip_officedoc_do_readrelationships($res);
 ipworkszip_officedoc_do_replacepart($res);
 ipworkszip_officedoc_do_reset($res);
 ipworkszip_officedoc_do_resolvecontenttype($res);

Remarks

The class provides a way to extract information and content from an Open XML packaged document, examine the package properties and basic read/update facilities.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ContentTypeCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the ContentType arrays.

Object Oriented Interface

public function getContentTypeCount();

Procedural Interface

ipworkszip_officedoc_get($res, 1 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContentTypeIsOverride
• ContentTypeMediaType
• ContentTypeTarget

The array indices start at 0 and end at ContentTypeCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ContentTypeIsOverride Property (IPWorksZip_OfficeDoc Class)

Specifies if this is a default content type or an override.

Object Oriented Interface

public function getContentTypeIsOverride($contenttypeindex);

Procedural Interface

ipworkszip_officedoc_get($res, 2 , $contenttypeindex);

Default Value

true

Remarks

Specifies if this is a default content type or an override.

The $contenttypeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ContentTypeMediaType Property (IPWorksZip_OfficeDoc Class)

The media type for this entry, as defined by RFC2616.

Object Oriented Interface

public function getContentTypeMediaType($contenttypeindex);

Procedural Interface

ipworkszip_officedoc_get($res, 3 , $contenttypeindex);

Default Value

''

Remarks

The media type for this entry, as defined by RFC2616.

The $contenttypeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

String

ContentTypeTarget Property (IPWorksZip_OfficeDoc Class)

If it's a default content type, this will be the file extension it applies to.

Object Oriented Interface

public function getContentTypeTarget($contenttypeindex);

Procedural Interface

ipworkszip_officedoc_get($res, 4 , $contenttypeindex);

Default Value

''

Remarks

If it's a default content type, this will be the file extension it applies to. Otherwise, it will be the part name.

The $contenttypeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

String

NamespaceCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();

Procedural Interface

ipworkszip_officedoc_get($res, 5 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

NamespacePrefix Property (IPWorksZip_OfficeDoc Class)

This property contains the Prefix for the Namespace .

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);

Procedural Interface

ipworkszip_officedoc_get($res, 6 , $namespaceindex);

Default Value

''

Remarks

This property contains the NamespacePrefix for the Namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

NamespaceURI Property (IPWorksZip_OfficeDoc Class)

This property contains the namespace URI associated with the corresponding Prefix .

Object Oriented Interface

public function getNamespaceURI($namespaceindex);

Procedural Interface

ipworkszip_officedoc_get($res, 7 , $namespaceindex);

Default Value

''

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePath Property (IPWorksZip_OfficeDoc Class)

The path to the Open XML package file.

Object Oriented Interface

public function getPackagePath();
public function setPackagePath($value);

Procedural Interface

ipworkszip_officedoc_get($res, 8 );
ipworkszip_officedoc_set($res, 8, $value );

Default Value

''

Remarks

This property specifies the path and filename of the Open XML package to work on.

Data Type

String

PackagePropertyCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the PackageProperty arrays.

Object Oriented Interface

public function getPackagePropertyCount();

Procedural Interface

ipworkszip_officedoc_get($res, 9 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackagePropertyDataType
• PackagePropertyName
• PackagePropertyNamespace
• PackagePropertyPropId
• PackagePropertyPropSet
• PackagePropertyValue

The array indices start at 0 and end at PackagePropertyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PackagePropertyDataType Property (IPWorksZip_OfficeDoc Class)

The data type associated with this property, if the information is available.

Object Oriented Interface

public function getPackagePropertyDataType($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 10 , $packagepropertyindex);

Default Value

''

Remarks

The data type associated with this property, if the information is available.

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyName Property (IPWorksZip_OfficeDoc Class)

The name of this property.

Object Oriented Interface

public function getPackagePropertyName($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 11 , $packagepropertyindex);

Default Value

''

Remarks

The name of this property

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyNamespace Property (IPWorksZip_OfficeDoc Class)

The XML Namespace URI associated with this property.

Object Oriented Interface

public function getPackagePropertyNamespace($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 12 , $packagepropertyindex);

Default Value

''

Remarks

The XML Namespace URI associated with this property. For custom properties, this will be an empty string.

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyPropId Property (IPWorksZip_OfficeDoc Class)

If this is a custom property, this will be the pid assigned to it.

Object Oriented Interface

public function getPackagePropertyPropId($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 13 , $packagepropertyindex);

Default Value

''

Remarks

If this is a custom property, this will be the pid assigned to it.

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyPropSet Property (IPWorksZip_OfficeDoc Class)

If this is a custom property, this will be the GUID of the property set it belongs to.

Object Oriented Interface

public function getPackagePropertyPropSet($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 14 , $packagepropertyindex);

Default Value

''

Remarks

If this is a custom property, this will be the GUID of the property set it belongs to.

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyValue Property (IPWorksZip_OfficeDoc Class)

The value of this property.

Object Oriented Interface

public function getPackagePropertyValue($packagepropertyindex);

Procedural Interface

ipworkszip_officedoc_get($res, 15 , $packagepropertyindex);

Default Value

''

Remarks

The value of this property

The $packagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PartData Property (IPWorksZip_OfficeDoc Class)

The contents of the currently selected part.

Object Oriented Interface

public function getPartData();
public function setPartData($value);

Procedural Interface

ipworkszip_officedoc_get($res, 16 );
ipworkszip_officedoc_set($res, 16, $value );

Default Value

''

Remarks

This property will hold the contents of the part selected by PartName after calling the ExtractPart method. It can also be set before calling ReplacePart.

Data Type

Binary String

PartName Property (IPWorksZip_OfficeDoc Class)

The name of the currently selected part.

Object Oriented Interface

public function getPartName();
public function setPartName($value);

Procedural Interface

ipworkszip_officedoc_get($res, 17 );
ipworkszip_officedoc_set($res, 17, $value );

Default Value

''

Remarks

This property specifies the name of the currently selected part in the document. If null or empty, no part is currently selected.

Data Type

String

RelationshipCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the Relationship arrays.

Object Oriented Interface

public function getRelationshipCount();

Procedural Interface

ipworkszip_officedoc_get($res, 18 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RelationshipContentType
• RelationshipId
• RelationshipPartName
• RelationshipTypeURI

The array indices start at 0 and end at RelationshipCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

RelationshipContentType Property (IPWorksZip_OfficeDoc Class)

The content type for the part referenced by this relationship, resolved from [Content_Types].

Object Oriented Interface

public function getRelationshipContentType($relationshipindex);

Procedural Interface

ipworkszip_officedoc_get($res, 19 , $relationshipindex);

Default Value

''

Remarks

The content type for the part referenced by this relationship, resolved from [Content_Types].xml according to the Open XML packaging specification rules.

The $relationshipindex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipId Property (IPWorksZip_OfficeDoc Class)

The unique ID of this relationship within this .

Object Oriented Interface

public function getRelationshipId($relationshipindex);

Procedural Interface

ipworkszip_officedoc_get($res, 20 , $relationshipindex);

Default Value

''

Remarks

The unique ID of this relationship within this .rels file

The $relationshipindex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipPartName Property (IPWorksZip_OfficeDoc Class)

The name of the part this relationship entry applies to.

Object Oriented Interface

public function getRelationshipPartName($relationshipindex);

Procedural Interface

ipworkszip_officedoc_get($res, 21 , $relationshipindex);

Default Value

''

Remarks

The name of the part this relationship entry applies to.

The $relationshipindex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipTypeURI Property (IPWorksZip_OfficeDoc Class)

The XML namespace URI that specifies the meaning of this relationship.

Object Oriented Interface

public function getRelationshipTypeURI($relationshipindex);

Procedural Interface

ipworkszip_officedoc_get($res, 22 , $relationshipindex);

Default Value

''

Remarks

The XML namespace URI that specifies the meaning of this relationship.

The $relationshipindex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

Validate Property (IPWorksZip_OfficeDoc Class)

This property controls whether documents are validated during parsing.

Object Oriented Interface

public function getValidate();
public function setValidate($value);

Procedural Interface

ipworkszip_officedoc_get($res, 23 );
ipworkszip_officedoc_set($res, 23, $value );

Default Value

true

Remarks

When true (default), the document will be validated during parsing. To disable validation set Validate to false. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed.

Data Type

Boolean

AttrCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the Attr arrays.

Object Oriented Interface

public function getAttrCount();

Procedural Interface

ipworkszip_officedoc_get($res, 24 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

AttrName Property (IPWorksZip_OfficeDoc Class)

The Name provides the local name (without prefix) of the attribute.

Object Oriented Interface

public function getAttrName($attrindex);

Procedural Interface

ipworkszip_officedoc_get($res, 25 , $attrindex);

Default Value

''

Remarks

The AttrName provides the local name (without prefix) of the attribute.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrNamespace Property (IPWorksZip_OfficeDoc Class)

This property contains the attribute namespace.

Object Oriented Interface

public function getAttrNamespace($attrindex);

Procedural Interface

ipworkszip_officedoc_get($res, 26 , $attrindex);

Default Value

''

Remarks

This property contains the attribute namespace.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrPrefix Property (IPWorksZip_OfficeDoc Class)

This property contains the attribute prefix (if any).

Object Oriented Interface

public function getAttrPrefix($attrindex);

Procedural Interface

ipworkszip_officedoc_get($res, 27 , $attrindex);

Default Value

''

Remarks

This property contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrValue Property (IPWorksZip_OfficeDoc Class)

This property contains the attribute value.

Object Oriented Interface

public function getAttrValue($attrindex);

Procedural Interface

ipworkszip_officedoc_get($res, 28 , $attrindex);

Default Value

''

Remarks

This property contains the attribute value.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

XChildCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the XChild arrays.

Object Oriented Interface

public function getXChildCount();

Procedural Interface

ipworkszip_officedoc_get($res, 29 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

XChildName Property (IPWorksZip_OfficeDoc Class)

The Name property provides the local name (without a prefix) of the element.

Object Oriented Interface

public function getXChildName($xchildindex);

Procedural Interface

ipworkszip_officedoc_get($res, 30 , $xchildindex);

Default Value

''

Remarks

The XChildName property provides the local name (without a prefix) of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildNamespace Property (IPWorksZip_OfficeDoc Class)

This property contains the namespace of the element.

Object Oriented Interface

public function getXChildNamespace($xchildindex);

Procedural Interface

ipworkszip_officedoc_get($res, 31 , $xchildindex);

Default Value

''

Remarks

This property contains the namespace of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildPrefix Property (IPWorksZip_OfficeDoc Class)

This property contains the prefix of the element (if any).

Object Oriented Interface

public function getXChildPrefix($xchildindex);

Procedural Interface

ipworkszip_officedoc_get($res, 32 , $xchildindex);

Default Value

''

Remarks

This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildXText Property (IPWorksZip_OfficeDoc Class)

This property contains the inner text of the element.

Object Oriented Interface

public function getXChildXText($xchildindex);

Procedural Interface

ipworkszip_officedoc_get($res, 33 , $xchildindex);

Default Value

''

Remarks

This property contains the inner text of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XElement Property (IPWorksZip_OfficeDoc Class)

The name of the current element.

Object Oriented Interface

public function getXElement();

Procedural Interface

ipworkszip_officedoc_get($res, 34 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XNamespace Property (IPWorksZip_OfficeDoc Class)

The namespace of the current element.

Object Oriented Interface

public function getXNamespace();

Procedural Interface

ipworkszip_officedoc_get($res, 35 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XParent Property (IPWorksZip_OfficeDoc Class)

This property includes the parent of the current element.

Object Oriented Interface

public function getXParent();

Procedural Interface

ipworkszip_officedoc_get($res, 36 );

Default Value

''

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

String

XPath Property (IPWorksZip_OfficeDoc Class)

This property provides a way to point to a specific element in the document.

Object Oriented Interface

public function getXPath();
public function setXPath($value);

Procedural Interface

ipworkszip_officedoc_get($res, 37 );
ipworkszip_officedoc_set($res, 37, $value );

Default Value

''

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildName, XChildNamespace, XChildPrefix, XChildXText, and XText providing other properties of the element. The attributes of the current element are provided in the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Data Type

String

XPrefix Property (IPWorksZip_OfficeDoc Class)

The prefix of the current element.

Object Oriented Interface

public function getXPrefix();

Procedural Interface

ipworkszip_officedoc_get($res, 38 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XSubTree Property (IPWorksZip_OfficeDoc Class)

This property includes a snapshot of the current element in the document.

Object Oriented Interface

public function getXSubTree();

Procedural Interface

ipworkszip_officedoc_get($res, 39 );

Default Value

''

Remarks

The current element is specified through the XPath property. For this property to work, you must set the CacheContent to True.

This property is read-only.

Data Type

String

XText Property (IPWorksZip_OfficeDoc Class)

The text of the current element.

Object Oriented Interface

public function getXText();

Procedural Interface

ipworkszip_officedoc_get($res, 40 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

Close Method (IPWorksZip_OfficeDoc Class)

Closes the Open XML package archive.

Object Oriented Interface

public function doClose();

Procedural Interface

ipworkszip_officedoc_do_close($res);

Remarks

When this method is called, the class will close the current archive and release all resources.

Config Method (IPWorksZip_OfficeDoc Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkszip_officedoc_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

ExtractPart Method (IPWorksZip_OfficeDoc Class)

Reads the contents of the currently selected part.

Object Oriented Interface

public function doExtractPart();

Procedural Interface

ipworkszip_officedoc_do_extractpart($res);

Remarks

If the part specified by the PartName property exists, the corresponding physical file will be extracted from the archive and will be available through the PartData property.

If the part doesn't exists, or it's stored in interleaved format, an error will be raised.

FindPartByType Method (IPWorksZip_OfficeDoc Class)

Looks up a part in the current relationships file by it's type namespace URI.

Object Oriented Interface

public function doFindPartByType($typeuri);

Procedural Interface

ipworkszip_officedoc_do_findpartbytype($res, $typeuri);

Remarks

If a matching part can be found, it's part name is returned. Otherwise, an empty string is returned.

GetPropertyValue Method (IPWorksZip_OfficeDoc Class)

Returns the value of the specified package property.

Object Oriented Interface

public function doGetPropertyValue($propname, $propnamespace);

Procedural Interface

ipworkszip_officedoc_do_getpropertyvalue($res, $propname, $propnamespace);

Remarks

Looks up a package property named PropName in namespace PropNamespace in the core and app properties tables and returns it's value, if found.

If the property doesn't exists, an empty string is returned.

For custom properties. use an empty string ("") as the value of the PropNamespace parameter.

ListParts Method (IPWorksZip_OfficeDoc Class)

List all the parts contained in the document and their relationships.

Object Oriented Interface

public function doListParts();

Procedural Interface

ipworkszip_officedoc_do_listparts($res);

Remarks

When this method is called, the class will read all the relationships in the document, recursively, and populate the Relationships collection.

Open Method (IPWorksZip_OfficeDoc Class)

Opens the Open XML package archive.

Object Oriented Interface

public function doOpen();

Procedural Interface

ipworkszip_officedoc_do_open($res);

Remarks

When this method is called, the class will attempt to open the archive specified in PackagePath and extract package properties, content types and parse the master relationships file in the archive.

ParsePart Method (IPWorksZip_OfficeDoc Class)

Parses the specified part as XML.

Object Oriented Interface

public function doParsePart();

Procedural Interface

ipworkszip_officedoc_do_parsepart($res);

Remarks

If the part specified by PartName exists, the corresponding physical file will be extracted from the archive and parsed as XML. If BuildDOM is enabled, the DOM will be built internally and you can use XPath to query the resulting document, using the XPath property. If BuildDOM is disabled, only the XML parser-related events will be fired.

ReadRelationships Method (IPWorksZip_OfficeDoc Class)

Reads the relationships file in the archive associated with the specified part.

Object Oriented Interface

public function doReadRelationships();

Procedural Interface

ipworkszip_officedoc_do_readrelationships($res);

Remarks

When this method is called, the class will look for a .rels file associated with the part specified by the PartName property. If found, the Relationships collection will now expose the contents of the relationships for that part.

ReplacePart Method (IPWorksZip_OfficeDoc Class)

Replaces the contents of the specified part in the package.

Object Oriented Interface

public function doReplacePart();

Procedural Interface

ipworkszip_officedoc_do_replacepart($res);

Remarks

If the part specified by the PartName property exists, the corresponding physical file will be replaced with the contents of the PartData property. The package file will be modified in place right away.

If the part doesn't exists, it's stored in interleaved format, or PartData is null or empty, an error will be raised.

Reset Method (IPWorksZip_OfficeDoc Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkszip_officedoc_do_reset($res);

Remarks

Reset resets the state of the class. All properties will be set to their default values, and any files open will be closed.

ResolveContentType Method (IPWorksZip_OfficeDoc Class)

Returns the content type of the specified part.

Object Oriented Interface

public function doResolveContentType();

Procedural Interface

ipworkszip_officedoc_do_resolvecontenttype($res);

Remarks

Applies the content type resolution rules specified in the Open XML packaging specification and returns the content type associated with PartName in the archive.

If there's no content type mapped for the part or for the extension, an empty string is returned.

BeginFile Event (IPWorksZip_OfficeDoc Class)

Fired before each file is processed.

Object Oriented Interface

public function fireBeginFile($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 1, array($this, 'fireBeginFile'));

Parameter List

 'index'
 'skip'

Remarks

BeginFile is fired before each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file about to be processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize (decompression only), and FileDecompressedSize fields of the Files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying FileDecompressedName and/or ExtractToPath. If FileDecompressedName is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the Progress event.

This event may also be trapped while compressing. FileCompressedName and FileDecompressedName may be changed.

You may set the Skip parameter to true in order to skip the file completely while compressing or extracting.

Characters Event (IPWorksZip_OfficeDoc Class)

This event is fired for plaintext segments of the input stream.

Object Oriented Interface

public function fireCharacters($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 2, array($this, 'fireCharacters'));

Parameter List

 'text'

Remarks

The Characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end-of-line characters, except for ignorable whitespace, which is fired through the IgnorableWhitespace event.

Comment Event (IPWorksZip_OfficeDoc Class)

This event is fired when a comment section is encountered.

Object Oriented Interface

public function fireComment($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 3, array($this, 'fireComment'));

Parameter List

 'text'

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (IPWorksZip_OfficeDoc Class)

This event is fired when an end-element tag is encountered.

Object Oriented Interface

public function fireEndElement($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 4, array($this, 'fireEndElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds to an empty element declaration.

EndFile Event (IPWorksZip_OfficeDoc Class)

Fired after each file is processed.

Object Oriented Interface

public function fireEndFile($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 5, array($this, 'fireEndFile'));

Parameter List

 'index'

Remarks

EndFile is fired after each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize, and FileDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

EndPrefixMapping Event (IPWorksZip_OfficeDoc Class)

This event is fired when leaving the scope of a namespace declaration.

Object Oriented Interface

public function fireEndPrefixMapping($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 6, array($this, 'fireEndPrefixMapping'));

Parameter List

 'prefix'

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (IPWorksZip_OfficeDoc Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EvalEntity Event (IPWorksZip_OfficeDoc Class)

This event is fired every time an entity needs to be evaluated.

Object Oriented Interface

public function fireEvalEntity($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 8, array($this, 'fireEvalEntity'));

Parameter List

 'entity'
 'value'

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

IgnorableWhitespace Event (IPWorksZip_OfficeDoc Class)

This event is fired when a section of ignorable whitespace is encountered.

Object Oriented Interface

public function fireIgnorableWhitespace($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 9, array($this, 'fireIgnorableWhitespace'));

Parameter List

 'text'

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (IPWorksZip_OfficeDoc Class)

This event fires when a meta section is encountered.

Object Oriented Interface

public function fireMeta($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 10, array($this, 'fireMeta'));

Parameter List

 'text'

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

Overwrite Event (IPWorksZip_OfficeDoc Class)

Fired whenever a file exists and may be overwritten.

Object Oriented Interface

public function fireOverwrite($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 11, array($this, 'fireOverwrite'));

Parameter List

 'filename'
 'overwrite'

Remarks

Overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression.

Filename contains the full name of the file, specified with its pathname.

Overwrite specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the OverwriteFiles property. For Gzip, this value defaults to true.

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the class, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

PI Event (IPWorksZip_OfficeDoc Class)

This event is fired when a processing instruction section is encountered.

Object Oriented Interface

public function firePI($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 12, array($this, 'firePI'));

Parameter List

 'text'

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

Progress Event (IPWorksZip_OfficeDoc Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 13, array($this, 'fireProgress'));

Parameter List

 'data'
 'filename'
 'bytesprocessed'
 'percentprocessed'

Remarks

The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

SpecialSection Event (IPWorksZip_OfficeDoc Class)

This event is fired when a special section is encountered.

Object Oriented Interface

public function fireSpecialSection($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 14, array($this, 'fireSpecialSection'));

Parameter List

 'sectionid'
 'text'

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, and the SectionId parameter provides the section identifier (e.g., CDATA).

StartElement Event (IPWorksZip_OfficeDoc Class)

This event is fired when a begin-element tag is encountered in the document.

Object Oriented Interface

public function fireStartElement($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 15, array($this, 'fireStartElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

The IsEmpty parameter is True when the event corresponds to an empty element declaration.

StartPrefixMapping Event (IPWorksZip_OfficeDoc Class)

This event is fired when entering the scope of a namespace declaration.

Object Oriented Interface

public function fireStartPrefixMapping($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 16, array($this, 'fireStartPrefixMapping'));

Parameter List

 'prefix'
 'uri'

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

Config Settings (OfficeDoc Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

OfficeDoc Config Settings

Base Config Settings

Trappable Errors (OfficeDoc Class)

Errors

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

Note that some non-fatal errors may be trapped and explicitly ignored in the Error event. This will allow the class to continue operation even in case of error.

OfficeDoc Errors