Skip to content

Releases: PHPOffice/PhpSpreadsheet

1.24.1 - 2022-07-18

18 Jul 19:52
Compare
Choose a tag to compare

Added

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

1.24.0 - 2022-07-09

09 Jul 13:58
Compare
Choose a tag to compare

Note that this will be the last 1.x branch release before the 2.x release. We will maintain both branches in parallel for a time; but users are requested to update to version 2.0 once that is fully available.

Added

  • Added removeComment() method for Worksheet PR #2875

  • Add point size option for scatter charts Issue #2298 PR #2801

  • Basic support for Xlsx reading/writing Chart Sheets PR #2830

    Note that a ChartSheet is still only written as a normal Worksheet containing a single chart, not as an actual ChartSheet.

  • Added Worksheet visibility in Ods Reader PR #2851 and Gnumeric Reader PR #2853

  • Added Worksheet visibility in Ods Writer PR #2850

  • Allow Csv Reader to treat string as contents of file Issue #1285 PR #2792

  • Allow Csv Reader to store null string rather than leave cell empty Issue #2840 PR #2842

  • Provide new Worksheet methods to identify if a row or column is "empty", making allowance for different definitions of "empty":

    • Treat rows/columns containing no cell records as empty (default)
    • Treat cells containing a null value as empty
    • Treat cells containing an empty string as empty

Changed

  • Modify rangeBoundaries(), rangeDimension() and getRangeBoundaries() Coordinate methods to work with row/column ranges as well as with cell ranges and cells PR #2926

  • Better enforcement of value modification to match specified datatype when using setValueExplicit()

  • Relax validation of merge cells to allow merge for a single cell reference Issue #2776

  • Memory and speed improvements, particularly for the Cell Collection, and the Writers.

    See the Discussion section on github for details of performance across versions

  • Improved performance for removing rows/columns from a worksheet

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

1.23.0 - 2022-04-24

24 Apr 13:55
Compare
Choose a tag to compare

Added

  • Ods Writer support for Freeze Pane Issue #2013 PR #2755

  • Ods Writer support for setting column width/row height (including the use of AutoSize) Issue #2346 PR #2753

  • Introduced CellAddress, CellRange, RowRange and ColumnRange value objects that can be used as an alternative to a string value (e.g. 'C5', 'B2:D4', '2:2' or 'B:C') in appropriate contexts.

  • Implementation of the FILTER(), SORT(), SORTBY() and UNIQUE() Lookup/Reference (array) functions.

  • Implementation of the ISREF() Information function.

  • Added support for reading "formatted" numeric values from Csv files; although default behaviour of reading these values as strings is preserved.

    (i.e a value of "12,345.67" can be read as numeric 12345.67, not simply as a string "12,345.67", if the castFormattedNumberToNumeric() setting is enabled.

    This functionality is locale-aware, using the server's locale settings to identify the thousands and decimal separators.

  • Support for two cell anchor drawing of images. #2532 #2674

  • Limited support for Xls Reader to handle Conditional Formatting:

    Ranges and Rules are read, but style is currently limited to font size, weight and color; and to fill style and color.

  • Add ability to suppress Mac line ending check for CSV #2623

  • Initial support for creating and writing Tables (Xlsx Writer only) PR #2671

    See /samples/Table for examples of use.

    Note that PreCalculateFormulas needs to be disabled when saving spreadsheets containing tables with formulae (totals or column formulae).

Changed

  • Gnumeric Reader now loads number formatting for cells.

  • Gnumeric Reader now correctly identifies selected worksheet and selected cells in a worksheet.

  • Some Refactoring of the Ods Reader, moving all formula and address translation from Ods to Excel into a separate class to eliminate code duplication and ensure consistency.

  • Make Boolean Conversion in Csv Reader locale-aware when using the String Value Binder.

    This is determined by the Calculation Engine locale setting.

    (i.e. "Vrai" wil be converted to a boolean true if the Locale is set to fr.)

  • Allow psr/simple-cache 2.x

Deprecated

  • All Excel Function implementations in Calculation\Functions (including the Error functions) have been moved to dedicated classes for groups of related functions. See the docblocks against all the deprecated methods for details of the new methods to call instead. At some point, these old classes will be deleted.

  • Worksheet methods that reference cells "byColumnandRow". All such methods have an equivalent that references the cell by its address (e.g. 'E3' rather than 5, 3).

    These functions now accept either a cell address string ('E3') or an array with columnId and rowId ([5, 3]) or a new CellAddress object as their cellAddress/coordinate argument.
    This includes the methods:

    • setCellValueByColumnAndRow() use the equivalent setCellValue()
    • setCellValueExplicitByColumnAndRow() use the equivalent setCellValueExplicit()
    • getCellByColumnAndRow() use the equivalent getCell()
    • cellExistsByColumnAndRow() use the equivalent cellExists()
    • getStyleByColumnAndRow() use the equivalent getStyle()
    • setBreakByColumnAndRow() use the equivalent setBreak()
    • mergeCellsByColumnAndRow() use the equivalent mergeCells()
    • unmergeCellsByColumnAndRow() use the equivalent unmergeCells()
    • protectCellsByColumnAndRow() use the equivalent protectCells()
    • unprotectCellsByColumnAndRow() use the equivalent unprotectCells()
    • setAutoFilterByColumnAndRow() use the equivalent setAutoFilter()
    • freezePaneByColumnAndRow() use the equivalent freezePane()
    • getCommentByColumnAndRow() use the equivalent getComment()
    • setSelectedCellByColumnAndRow() use the equivalent setSelectedCells()

    This change provides more consistency in the methods (not every "by cell address" method has an equivalent "byColumnAndRow" method);
    and the "by cell address" methods often provide more flexibility, such as allowing a range of cells, or referencing them by passing the defined name of a named range as the argument.

Removed

  • Nothing

Fixed

  • Make allowance for the AutoFilter dropdown icon in the first row of an Autofilter range when using Autosize columns. Issue #2413 PR #2754

  • Support for "chained" ranges (e.g. A5:C10:C20:F1) in the Calculation Engine; and also support for using named ranges with the Range operator (e.g. NamedRange1:NamedRange2) Issue #2730 PR #2746

  • Update Conditional Formatting ranges and rule conditions when inserting/deleting rows/columns Issue #2678 PR #2689

  • Allow INDIRECT() to accept row/column ranges as well as cell ranges PR #2687

  • Fix bug when deleting cells with hyperlinks, where the hyperlink was then being "inherited" by whatever cell moved to that cell address.

  • Fix bug in Conditional Formatting in the Xls Writer that resulted in a broken file when there were multiple conditional ranges in a worksheet.

  • Fix Conditional Formatting in the Xls Writer to work with rules that contain string literals, cell references and formulae.

  • Fix for setting Active Sheet to the first loaded worksheet when bookViews element isn't defined Issue #2666 PR #2669

  • Fixed behaviour of XLSX font style vertical align settings PR #2619

  • Resolved formula translations to handle separators (row and column) for array functions as well as for function argument separators; and cleanly handle nesting levels.

    Note that this method is used when translating Excel functions between en_us and other locale languages, as well as when converting formulae between different spreadsheet formats (e.g. Ods to Excel).

    Nor is this a perfect solution, as there may still be issues when function calls have array arguments that themselves contain function calls; but it's still better than the current logic.

  • Fix for escaping double quotes within a formula Issue #1971 PR #2651

  • Change open mode for output from wb+ to wb Issue #2372 PR #2657

  • Use color palette if supplied Issue #2499 PR #2595

  • Xls reader treat drawing offsets as int rather than float PR #2648

  • Handle booleans in conditional styles properly PR #2654

  • Fix for reading files in the root directory of a ZipFile, which should not be prefixed by relative paths ("./") as dirname($filename) does by default.

  • Fix invalid style of cells in empty columns with columnDimensions and rows with rowDimensions in added external sheet. PR #2739

  • Time Interval Formatting Issue #2768 PR #2772

1.22.0

18 Feb 12:58
1.22.0
3a9e29b
Compare
Choose a tag to compare

Added

  • Namespacing phase 2 - styles.
    PR #2471

  • Improved support for passing of array arguments to Excel function implementations to return array results (where appropriate). Issue #2551

    This is the first stage in an ongoing process of adding array support to all appropriate function implementations,

  • Support for the Excel365 Math/Trig SEQUENCE() function PR #2536

  • Support for the Excel365 Math/Trig RANDARRAY() function PR #2540

    Note that the Spill Operator is not yet supported in the Calculation Engine; but this can still be useful for defining array constants.

  • Improved support for Conditional Formatting Rules PR #2491

    • Provide support for a wider range of Conditional Formatting Rules for Xlsx Reader/Writer:

      • Cells Containing (cellIs)
      • Specific Text (containing, notContaining, beginsWith, endsWith)
      • Dates Occurring (all supported timePeriods)
      • Blanks/NoBlanks
      • Errors/NoErrors
      • Duplicates/Unique
      • Expression
    • Provision of CF Wizards (for all the above listed rule types) to help create/modify CF Rules without having to manage all the combinations of types/operators, and the complexities of formula expressions, or the text/timePeriod attributes.

      See documentation for details

    • Full support of the above CF Rules for the Xlsx Reader and Writer; even when the file being loaded has CF rules listed in the <extLst><ext><ConditionalFormattings> element for the worksheet rather than the <ConditionalFormatting> element.

    • Provision of a CellMatcher to identify if rules are matched for a cell, and which matching style will be applied.

    • Improved documentation and examples, covering all supported CF rule types.

  • Add support for one digit decimals (FORMAT_NUMBER_0, FORMAT_PERCENTAGE_0). PR #2525

  • Initial work enabling Excel function implementations for handling arrays as arguments when used in "array formulae" #2562

  • Enable most of the Date/Time functions to accept array arguments #2573

  • Array ready functions - Text, Math/Trig, Statistical, Engineering and Logical #2580

Changed

  • Additional Russian translations for Excel Functions (courtesy of aleks-samurai).
  • Improved code coverage for NumberFormat. PR #2556
  • Extract some methods from the Calculation Engine into dedicated classes #2537
  • Eliminate calls to flattenSingleValue() that are no longer required when we're checking for array values as arguments #2590

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed ReferenceHelper@insertNewBefore behavior when removing column before last column with null value
    PR #2541
  • Fix bug with DOLLARDE() and DOLLARFR() functions when the dollar value is negative Issue #2578 PR #2579
  • Fix partial function name matching when translating formulae from Russian to English Issue #2533 PR #2534
  • Various bugs related to Conditional Formatting Rules, and errors in the Xlsx Writer for Conditional Formatting PR #2491
  • Xlsx Reader merge range fixes.
    Issue #2501
    PR #2504
  • Handle explicit "date" type for Cell in Xlsx Reader.
    Issue #2373
    PR #2485
  • Recalibrate Row/Column Dimensions after removeRow/Column.
    Issue #2442
    PR #2486
  • Refinement for XIRR.
    Issue #2469
    PR #2487
  • Xlsx Reader handle cell with non-null explicit type but null value.
    Issue #2488
    PR #2489
  • Xlsx Reader fix height and width for oneCellAnchorDrawings.
    PR #2492
  • Fix rounding error in NumberFormat::NUMBER_PERCENTAGE, NumberFormat::NUMBER_PERCENTAGE_00. PR #2555
  • Don't treat thumbnail file as xml.
    Issue #2516
    PR #2517
  • Eliminating Xlsx Reader warning when no sz tag for RichText.
    Issue #2542
    PR #2550
  • Fix Xlsx/Xls Writer handling of inline strings.
    Issue #353
    PR #2569
  • Richtext colors were not being read correctly after namespace change #2458
  • Fix discrepancy between the way markdown tables are rendered in ReadTheDocs and in PHPStorm #2520
  • Update Russian Functions Text File #2557
  • Fix documentation, instantiation example #2564

1.21.0

06 Jan 11:11
1.21.0
1a359d2
Compare
Choose a tag to compare

Added

  • Ability to add a picture to the background of the comment. Supports four image formats: png, jpeg, gif, bmp. New Comment::setSizeAsBackgroundImage() to change the size of a comment to the size of a background image. Issue #1547 PR #2422
  • Ability to set default paper size and orientation PR #2410
  • Ability to extend AutoFilter to Maximum Row PR #2414

Changed

  • Xlsx Writer will evaluate AutoFilter only if it is as yet unevaluated, or has changed since it was last evaluated PR #2414

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

1.20.0

23 Nov 15:25
1.20.0
44436f2
Compare
Choose a tag to compare

Added

  • Xlsx Writer Support for WMF Files #2339
  • Use standard temporary file for internal use of HTMLPurifier #2383

Changed

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed null conversation for strToUpper #2292
  • Fixed Trying to access array offset on value of type null (Xls Reader) #2315
  • Don't corrupt XLSX files containing data validation #2377
  • Non-fixed cells were not updated if shared formula has a fixed cell #2354
  • Declare key of generic ArrayObject
  • CSV reader better support for boolean values #2374
  • Some ZIP file could not be read #2376
  • Fix regression were hyperlinks could not be read #2391
  • AutoFilter Improvements #2393
  • Don't corrupt file when using chart with fill color #589
  • Restore imperfect array formula values in xlsx writer #2343
  • Restore explicit list of changes to PHPExcel migration document #1546

1.19.0

31 Oct 15:11
a9ab55b
Compare
Choose a tag to compare

Added

  • Ability to set style on named range, and validate input to setSelectedCells Issue #2279 PR #2280
  • Process comments in Sylk file Issue #2276 PR #2277
  • Addition of Custom Properties to Ods Writer, and 32-bit-safe timestamps for Document Properties PR #2113
  • Added callback to CSV reader to set user-specified defaults for various properties (especially for escape which has a poor PHP-inherited default of backslash which does not correspond with Excel) PR #2103
  • Phase 1 of better namespace handling for Xlsx, resolving many open issues PR #2173 PR #2204 PR #2303
  • Add ability to extract images if source is a URL Issue #1997 PR #2072
  • Support for passing flags in the Reader load() and Writer save()methods, and through the IOFactory, to set behaviours PR #2136
  • More flexibility in the StringValueBinder to determine what datatypes should be treated as strings PR #2138
  • Helper class for conversion between css size Units of measure (px, pt, pc, in, cm, mm) PR #2152
  • Allow Row height and Column Width to be set using different units of measure (px, pt, pc, in, cm, mm), rather than only in points or MS Excel column width units PR #2152
  • Ability to stream to an Amazon S3 bucket Issue #2249
  • Provided a Size Helper class to validate size values (pt, px, em) PR #1694

Changed

  • Nothing.

Deprecated

  • PHP 8.1 will deprecate auto_detect_line_endings. As a result of this change, Csv Reader using PHP8.1+ will no longer be able to handle a Csv with Mac line endings.

Removed

  • Nothing.

Fixed

Read more

1.18.0

31 May 18:34
Compare
Choose a tag to compare

Added

  • Enhancements to CSV Reader, allowing options to be set when using IOFactory::load() with a callback to set delimiter, enclosure, charset etc. PR #2103 - See documentation for details.
  • Implemented basic AutoFiltering for Ods Reader and Writer PR #2053
  • Implemented basic AutoFiltering for Gnumeric Reader PR #2055
  • Improved support for Row and Column ranges in formulae Issue #1755 PR #2028
  • Implemented URLENCODE() Web Function
  • Implemented the CHITEST(), CHISQ.DIST() and CHISQ.INV() and equivalent Statistical functions, for both left- and right-tailed distributions.
  • Support for ActiveSheet and SelectedCells in the ODS Reader and Writer. PR #1908
  • Support for notContainsText Conditional Style in xlsx Issue #984

Changed

  • Use of nb rather than no as the locale code for Norsk Bokmål.

Deprecated

  • All Excel Function implementations in Calculation\Database, Calculation\DateTime, Calculation\Engineering, Calculation\Financial, Calculation\Logical, Calculation\LookupRef, Calculation\MathTrig, Calculation\Statistical, Calculation\TextData and Calculation\Web have been moved to dedicated classes for individual functions or groups of related functions. See the docblocks against all the deprecated methods for details of the new methods to call instead. At some point, these old classes will be deleted.

Removed

  • Use of nb rather than no as the locale language code for Norsk Bokmål.

Fixed

  • Fixed error in COUPNCD() calculation for end of month Issue #2116 - PR #2119
  • Resolve default values when a null argument is passed for HLOOKUP(), VLOOKUP() and ADDRESS() functions Issue #2120 - PR #2121
  • Fixed incorrect R1C1 to A1 subtraction formula conversion (R[-2]C-R[2]C) Issue #2076 PR #2086
  • Correctly handle absolute A1 references when converting to R1C1 format PR #2060
  • Correct default fill style for conditional without a pattern defined Issue #2035 PR #2050
  • Fixed issue where array key check for existince before accessing arrays in Xlsx.php. PR #1970
  • Fixed issue with quoted strings in number format mask rendered with toFormattedString() Issue 1972# PR #1978
  • Fixed issue with percentage formats in number format mask rendered with toFormattedString() Issue 1929# PR #1928
  • Fixed issue with _ spacing character in number format mask corrupting output from toFormattedString() Issue 1924# PR #1927
  • Fix for Issue #1887 - Lose Track of Selected Cells After Save
  • Fixed issue with Xlsx@listWorksheetInfo not returning any data
  • Fixed invalid arguments triggering mb_substr() error in LEFT(), MID() and RIGHT() text functions. Issue #640
  • Fix for Issue #1916 - Invalid signature check for XML files
  • Fix change in Font::setSize() behavior for PHP8. PR #2100

1.17.1

02 Mar 17:56
Compare
Choose a tag to compare

Added

  • Implementation of the Excel AVERAGEIFS() functions as part of a restructuring of Database functions and Conditional Statistical functions.
  • Support for date values and percentages in query parameters for Database functions, and the IF expressions in functions like COUNTIF() and AVERAGEIF(). #1875
  • Support for booleans, and for wildcard text search in query parameters for Database functions, and the IF expressions in functions like COUNTIF() and AVERAGEIF(). #1876
  • Implemented DataBar for conditional formatting in Xlsx, providing read/write and creation of (type, value, direction, fills, border, axis position, color settings) as DataBar options in Excel. #1754
  • Alignment for ODS Writer #1796
  • Basic implementation of the PERMUTATIONA() Statistical Function

Changed

  • Formula functions that previously called PHP functions directly are now processed through the Excel Functions classes; resolving issues with PHP8 stricter typing. #1789

    The following MathTrig functions are affected:
    ABS(), ACOS(), ACOSH(), ASIN(), ASINH(), ATAN(), ATANH(),
    COS(), COSH(), DEGREES() (rad2deg), EXP(), LN() (log), LOG10(),
    RADIANS() (deg2rad), SIN(), SINH(), SQRT(), TAN(), TANH().

    One TextData function is also affected: REPT() (str_repeat).

  • formatAsDate correctly matches language metadata, reverting c55272e

  • Formulae that previously crashed on sub function call returning excel error value now return said value.
    The following functions are affected CUMPRINC(), CUMIPMT(), AMORLINC(),
    AMORDEGRC().

  • Adapt some function error return value to match excel's error.
    The following functions are affected PPMT(), IPMT().

Deprecated

  • Calling many of the Excel formula functions directly rather than through the Calculation Engine.

    The logic for these Functions is now being moved out of the categorised Database, DateTime, Engineering, Financial, Logical, LookupRef, MathTrig, Statistical, TextData and Web classes into small, dedicated classes for individual functions or related groups of functions.

    This makes the logic in these classes easier to maintain; and will reduce the memory footprint required to execute formulae when calling these functions.

Removed

  • Nothing.

Fixed

  • Avoid Duplicate Titles When Reading Multiple HTML Files.Issue #1823 PR #1829
  • Fixed issue with Worksheet's getCell() method when trying to get a cell by defined name. #1858
  • Fix possible endless loop in NumberFormat Masks #1792
  • Fix problem resulting from literal dot inside quotes in number format masks. PR #1830
  • Resolve Google Sheets Xlsx charts issue. Google Sheets uses oneCellAnchor positioning and does not include *Cache values in the exported Xlsx. PR #1761
  • Fix for Xlsx Chart axis titles mapping to correct X or Y axis label when only one is present. PR #1760
  • Fix For Null Exception on ODS Read of Page Settings. #1772
  • Fix Xlsx reader overriding manually set number format with builtin number format. PR #1805
  • Fix Xlsx reader cell alignment. PR #1710
  • Fix for not yet implemented data-types in Open Document writer Issue #1674
  • Fix XLSX reader when having a corrupt numeric cell data type PR #1664
  • Fix on CUMPRINC(), CUMIPMT(), AMORLINC(), AMORDEGRC() usage. When those functions called one of YEARFRAC(), PPMT(), IPMT() and they would get back an error value (represented as a string), trying to use numeral operands (+, /, -, *) on said return value and a number (float or int`) would fail.

1.17.0

02 Mar 17:40
42e8680
Compare
Choose a tag to compare

Added

  • Implementation of the Excel AVERAGEIFS() functions as part of a restructuring of Database functions and Conditional Statistical functions.
  • Support for date values and percentages in query parameters for Database functions, and the IF expressions in functions like COUNTIF() and AVERAGEIF(). #1875
  • Support for booleans, and for wildcard text search in query parameters for Database functions, and the IF expressions in functions like COUNTIF() and AVERAGEIF(). #1876
  • Implemented DataBar for conditional formatting in Xlsx, providing read/write and creation of (type, value, direction, fills, border, axis position, color settings) as DataBar options in Excel. #1754
  • Alignment for ODS Writer #1796
  • Basic implementation of the PERMUTATIONA() Statistical Function

Changed

  • Formula functions that previously called PHP functions directly are now processed through the Excel Functions classes; resolving issues with PHP8 stricter typing. #1789

    The following MathTrig functions are affected:
    ABS(), ACOS(), ACOSH(), ASIN(), ASINH(), ATAN(), ATANH(),
    COS(), COSH(), DEGREES() (rad2deg), EXP(), LN() (log), LOG10(),
    RADIANS() (deg2rad), SIN(), SINH(), SQRT(), TAN(), TANH().

    One TextData function is also affected: REPT() (str_repeat).

  • formatAsDate correctly matches language metadata, reverting c55272e

  • Formulae that previously crashed on sub function call returning excel error value now return said value.
    The following functions are affected CUMPRINC(), CUMIPMT(), AMORLINC(),
    AMORDEGRC().

  • Adapt some function error return value to match excel's error.
    The following functions are affected PPMT(), IPMT().

Deprecated

  • Calling many of the Excel formula functions directly rather than through the Calculation Engine.

    The logic for these Functions is now being moved out of the categorised Database, DateTime, Engineering, Financial, Logical, LookupRef, MathTrig, Statistical, TextData and Web classes into small, dedicated classes for individual functions or related groups of functions.

    This makes the logic in these classes easier to maintain; and will reduce the memory footprint required to execute formulae when calling these functions.

Removed

  • Nothing.

Fixed

  • Avoid Duplicate Titles When Reading Multiple HTML Files.Issue #1823 PR #1829
  • Fixed issue with Worksheet's getCell() method when trying to get a cell by defined name. #1858
  • Fix possible endless loop in NumberFormat Masks #1792
  • Fix problem resulting from literal dot inside quotes in number format masks. PR #1830
  • Resolve Google Sheets Xlsx charts issue. Google Sheets uses oneCellAnchor positioning and does not include *Cache values in the exported Xlsx. PR #1761
  • Fix for Xlsx Chart axis titles mapping to correct X or Y axis label when only one is present. PR #1760
  • Fix For Null Exception on ODS Read of Page Settings. #1772
  • Fix Xlsx reader overriding manually set number format with builtin number format. PR #1805
  • Fix Xlsx reader cell alignment. PR #1710
  • Fix for not yet implemented data-types in Open Document writer Issue #1674
  • Fix XLSX reader when having a corrupt numeric cell data type PR #1664
  • Fix on CUMPRINC(), CUMIPMT(), AMORLINC(), AMORDEGRC() usage. When those functions called one of YEARFRAC(), PPMT(), IPMT() and they would get back an error value (represented as a string), trying to use numeral operands (+, /, -, *) on said return value and a number (float or int`) would fail.