1. class
  2. Neos
  3. \
  4. Neos
  5. \
  6. Domain
  7. \
  8. Service
  9. \
  10. SiteExportService

SiteExportService

class SiteExportService (View source)

The Site Export Service

Properties

protected ContextFactoryInterface $contextFactory
protected NodeExportService $nodeExportService
protected PackageManager $packageManager
protected string $resourcesPath

Absolute path to exported resources, or NULL if resources should be inlined in the exported XML
protected XMLWriter $xmlWriter

The XMLWriter that is used to construct the export.

Methods

string
export(array $sites, bool $tidy = false, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it into XML.

void
exportToPackage(array $sites, bool $tidy, string $packageKey, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it into XML in the given package.

void
exportToFile(array $sites, bool $tidy, string $pathAndFilename, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it as XML into the given file.

void
exportSites(array $sites, string $nodeTypeFilter)

Exports the given sites to the XMLWriter

void
exportSite(Site $site, string $nodeTypeFilter)

Export the given $site to the XMLWriter

Details

at line 70
string export(array $sites, bool $tidy = false, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it into XML.

Parameters

array $sites
bool $tidy

Whether to export formatted XML
string $nodeTypeFilter

Filter the node type of the nodes, allows complex expressions (e.g. "Neos.Neos:Page", "!Neos.Neos:Page,Neos.Neos:Text")

Return Value

string

at line 91
void exportToPackage(array $sites, bool $tidy, string $packageKey, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it into XML in the given package.

Parameters

array $sites
bool $tidy

Whether to export formatted XML
string $packageKey

Package key where the export output should be saved to
string $nodeTypeFilter

Filter the node type of the nodes, allows complex expressions (e.g. "Neos.Neos:Page", "!Neos.Neos:Page,Neos.Neos:Text")

Return Value

void

Exceptions

Exception

at line 119
void exportToFile(array $sites, bool $tidy, string $pathAndFilename, string $nodeTypeFilter = null)

Fetches the site with the given name and exports it as XML into the given file.

Parameters

array $sites
bool $tidy

Whether to export formatted XML
string $pathAndFilename

Path to where the export output should be saved to
string $nodeTypeFilter

Filter the node type of the nodes, allows complex expressions (e.g. "Neos.Neos:Page", "!Neos.Neos:Page,Neos.Neos:Text")

Return Value

void

at line 140
protected void exportSites(array $sites, string $nodeTypeFilter)

Exports the given sites to the XMLWriter

Parameters

array $sites
string $nodeTypeFilter

Return Value

void

at line 160
protected void exportSite(Site $site, string $nodeTypeFilter)

Export the given $site to the XMLWriter

Parameters

Site $site
string $nodeTypeFilter

Return Value

void