Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

ezmatrix

Summary

Contains information about a matrix.

Persistent

No.

Attributes

Attribute

Type

Static*

Description

name

boolean

Yes.

Always FALSE (this attribute is currently not used).

rows

array

No.

A collection of miscellaneous structures that contain information about the rows. Currently there is only one structure, called "sequential". It is built up of an array of hashes. The following table reveals the structure of the array elements.

Name

Type

Description

identifier

string

The identifier of the column (defined at the class level).

name

string

The name of the column (defined at the class level).

columns

array

An array of strings holding the actual contents of the columns.

columns

array

No.

A collection of miscellaneous structures that contain information about the rows. Currently there are two types of structures: "sequential" and "id". The "sequential" structure is built up of an array hashes. The following table reveals the structure of the array elements.

Name

Type

Description

identifier

string

The identifier of the column (defined at the class level).

index

string

The row index ("0", "1", and so on).

name

string

The name of the column (defined at the class level).

rows

array

An array of strings holding the actual contents of the rows.

The "id" structure consists of hash where the keys are the column identifiers. The following table shows the structure that is available for each column identifier.

Name

Type

Description

identifier

string

The identifier of the column (defined at the class level).

index

string

The column index ("0", "1", and so on).

name

string

The name of the column (defined at the class level).

rows

array

An array of strings holding the actual contents of the rows.

cells

array

Yes.

A flat array of the cells that make up the matrix (from left to right, top to bottom).

matrix

array

Yes.

Consists of "rows", "columns" and "cells" (see above).

rowCount

integer

No.

The number of rows.

columnCount

integer

No.

The number of columns.

* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.

Balazs Halasy (29/03/2005 2:50 pm)

Svitlana Shatokhina (13/02/2007 1:01 pm)

Balazs Halasy, Svitlana Shatokhina


Comments

There are no comments.