model/modx/transport/modtransportmanager.class.php

Classes

package: modx
subpackage: transport
Classes: modTransportManager

Description

\modTransportManager
jump to top

package: modx
subpackage: transport
Properties: $config; $modx; $providers; $workspace
Methods: __construct; changeActiveWorkspace; getActiveWorkspace; getProviders; scanForPackages; scanForUpdates

Description

Properties

$configThe configuration array for the TransportManager.
jump to class

array $config = 'array'

Details

: array
The configuration array for the TransportManager.
visibility: public
default: array
final: false
static: false

$modxA reference to the MODX object.
jump to class

\MODX $modx = 'null'

Details

: \MODX
A reference to the MODX object.
visibility: public
default: null
final: false
static: false

$providersAn array of active providers.
jump to class

array $providers = 'array'

Details

: array
An array of active providers.
visibility: public
default: array
final: false
static: false

$workspaceThe active MODX workspace.
jump to class

\modWorkspace $workspace = 'null'

Details

: \modWorkspace
The active MODX workspace.
visibility: public
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          \xPDO $modx
          )
        
        :
        \modTransportManager

Creates an instance of the modTransportManager class.

Arguments

$modx: \xPDO
&$modx A reference to a modX instance.

Output

\modTransportManager

Details

visibility: public
final: false
static: false

changeActiveWorkspace
jump to class

changeActiveWorkspace(
          integer $workspaceId
          )
        
        :
        \modWorkspace

Change the active workspace in MODX.

Arguments

$workspaceId: integer
The PK of the modWorkspace.

Output

\modWorkspace

Details

visibility: public
final: false
static: false
access: public

getActiveWorkspace
jump to class

getActiveWorkspace(
          
          )
        
        :
        \modWorkspace

Get the active workspace for the MODX installation.

Output

\modWorkspace

Details

visibility: public
final: false
static: false
access: public

getProviders
jump to class

getProviders(
          boolean $refresh
              =
              false
          )
        
        :
        array

Get a list of providers for the transports.

Arguments

$refresh: boolean
If true, refresh the list of providers. Defaults to false.

Output

array: A list of providers.

Details

visibility: public
final: false
static: false
access: public

scanForPackages
jump to class

scanForPackages(
          
          )
        
        :
        array

Scans all providers for a list of packages.

Output

array: An array of packages.

Details

visibility: public
final: false
static: false
access: public

scanForUpdates
jump to class

scanForUpdates(
          
          )
        
        :
        array

Scans all providers for a list of updates for all packages.

Output

array: An array of updates for packages.

Details

visibility: public
final: false
static: false
access: public

model/modx/transport/modtransportmanager.class.php

Description

\modTransportManagerjump to top

Description

Properties

$configThe configuration array for the TransportManager.jump to class

Details

$modxA reference to the MODX object.jump to class

Details

$providersAn array of active providers.jump to class

Details

$workspaceThe active MODX workspace.jump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

changeActiveWorkspacejump to class

Arguments

Output

Details

getActiveWorkspacejump to class

Output

Details

getProvidersjump to class

Arguments

Output

Details

scanForPackagesjump to class

Output

Details

scanForUpdatesjump to class

Output

Details

\modTransportManager
jump to top

$configThe configuration array for the TransportManager.
jump to class

$modxA reference to the MODX object.
jump to class

$providersAn array of active providers.
jump to class

$workspaceThe active MODX workspace.
jump to class

__construct
jump to class

changeActiveWorkspace
jump to class

getActiveWorkspace
jump to class

getProviders
jump to class

scanForPackages
jump to class

scanForUpdates
jump to class