model/modx/import/modimport.class.php

Classes

package: modx
subpackage: import
Classes: modImport

Description

Provides common functions for importing content into a modX repository.

\modImport
jump to top

package: modx
subpackage: import
Properties: $modx; $properties; $results
Methods: __construct; getFileContent; getFileContentType; getFiles; log

Description

Provides common functions for importing content into a modX repository.

Properties

$modxA reference to the modX instance
jump to class

\modX $modx = 'null'

Details

: \modX
A reference to the modX instance
visibility: public
default: null
final: false
static: false

$propertiesA collection of properties that are being used in this import
jump to class

array $properties = 'array'

Details

: array
A collection of properties that are being used in this import
visibility: public
default: array
final: false
static: false

$resultsA collection of results in an array
jump to class

array $results = 'array'

Details

: array
A collection of results in an array
visibility: public
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          \modX $modx
          )
        
        :

Arguments

$modx: \modX
A reference to the modX instance

Details

visibility: public
final: false
static: false

getFileContent
jump to class

getFileContent(
          string $file
          )
        
        :
        string

Gets the buffered content of a file

Arguments

$file: string
An absolute path to the file

Output

string

Details

visibility: public
final: false
static: false

getFileContentType
jump to class

getFileContentType(
          \$extension $extension
          )
        
        :
        string

Gets the content type of a file

Arguments

$extension: \$extension
The extension of the file

Output

string: The content-type of the file

Details

visibility: public
final: false
static: false

getFiles
jump to class

getFiles(
          array $filesfound, string $directory, array $listing
              =
              array, int $count
              =
              0
          )
        
        :
        array

Arguments

$filesfound: array
A reference to an array of file locations
$directory: string
The directory to import from
$listing: array
A listing of imported files
$count: int
The current count iteration

Output

array

Details

visibility: public
final: false
static: false

log
jump to class

log(
          string $message
          )
        
        :
        void

Log a message to the results array

Arguments

$message: string
A string message to log

Details

visibility: public
final: false
static: false

model/modx/import/modimport.class.php

Description

\modImportjump to top

Description

Properties

$modxA reference to the modX instancejump to class

Details

$propertiesA collection of properties that are being used in this importjump to class

Details

$resultsA collection of results in an arrayjump to class

Details

Methods

__constructjump to class

Arguments

Details

getFileContentjump to class

Arguments

Output

Details

getFileContentTypejump to class

Arguments

Output

Details

getFilesjump to class

Arguments

Output

Details

logjump to class

Arguments

Details

\modImport
jump to top

$modxA reference to the modX instance
jump to class

$propertiesA collection of properties that are being used in this import
jump to class

$resultsA collection of results in an array
jump to class

__construct
jump to class

getFileContent
jump to class

getFileContentType
jump to class

getFiles
jump to class

log
jump to class