PagesExportImport class

This class is in development and not yet ready for use.

$options argument for import methods:

  • commit (bool): Commit/save the changes now? Default:true Specify false to perform a test import.
  • update (bool): Allow update of existing pages? Default:true
  • create (bool): Allow creation of new pages? Default:true
  • parent (Page|string|int): Parent Page, path or ID. Omit to use import data Default:0
  • template (Template|string|int): Template object, name or ID. Omit to use import data Default:0
  • fieldNames (array): Import only these field names, or omit to use all import data Default:[]
  • changeStatus (bool): Allow status to be changed aon existing pages? Default:true
  • changeSort (bool): Allow sort and sortfield to be changed on existing pages? Default:true

Note: all the "change" prefix options require update=true.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PagesExportImport class also inherits all the methods and properties of: Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
PagesExportImport::arrayToPage(array $a)
Page NullPageImport an array of page data to a new Page (or update existing page) 
PagesExportImport::arrayToPages(array $a)
PageArray intImport an array of page data to create or update pages 
PagesExportImport::cleanupFiles()
intRemove files and directories in /site/assets/backups/PagesExportImport/ that are older than $maxAge 
PagesExportImport::exportJSON(PageArray $items)
stringExport a PageArray to JSON string 
PagesExportImport::exportZIP(PageArray $items)
stringExport given PageArray to a ZIP file 
PagesExportImport::getExportPath()
stringGet the path where ZIP exports are stored 
PagesExportImport::getFieldInfo(Field $field)
arrayReturns array of information about given Field 
PagesExportImport::getImportInfo(array $a)
arrayReturn array of info about the import data 
PagesExportImport::importJSON(string $json)
PageArray boolImport a PageArray from a JSON string 
PagesExportImport::importZIP(string $filename)
PageArray boolImport ZIP file to create pages 
PagesExportImport::pagesToArray(PageArray $items)
arrayGiven a PageArray export it to a portable PHP array 

Additional methods and properties

In addition to the methods and properties above, PagesExportImport also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251