core/model/modx/modtranslate095.class.php

Show: inherited
Table of Contents

MODX Revolution

Copyright 2006-2012 by MODX, LLC. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Package
modx  

\modTranslate095

Package: modx

Utility class for assisting in migrating content from older MODX releases.

Children
\modTranslator

Properties

Propertypublic\modX  $modx= 'null'

A reference to the modX instance

Default valuenullDetails
Type
\modX
Propertypublic\modParser095  $parser= 'null'

The parsing engine for interpreting Evolution-style tags

Default valuenullDetails
Type
\modParser095

Methods

methodpublic__construct( \modX $modx ) : void

Initializes the class and sets up a translation map

Parameters
Name Type Description
$modx \modX

A reference to the modX instance

methodpublicgetParser( ) : \modParser095

Gets the parsing engine

Returns
Type Description
\modParser095
methodpublictranslateFiles( boolean $save = false, array $files = array() ) : string

Translate specific files

Parameters
Name Type Description
$save boolean

If true, will save the translation

$files array

An array of files to translate

Returns
Type Description
string
methodpublictranslateSite( boolean $save = false, null $classes = null, array $files = array (), boolean | string $toFile = false ) : void

Translate the site into Revolution-style tags

Parameters
Name Type Description
$save boolean

Whether or not to actually save the content changed

$classes null

An array of classes and fields to translate

$files array

An array of files to attempt to translate

$toFile boolean | string

If true, will write the file to the specified log

Documentation was generated by DocBlox 0.18.1.