core/model/modx/transport/modtransportmanager.class.php

Show: inherited
Table of Contents

Package
modx  
Subpackage
transport  

\modTransportManager

Package: modx\transport

Properties

Propertypublicarray  $config= 'array ()'

The configuration array for the TransportManager.
Default valuearray ()Details
Type
array
Propertypublic\MODX  $modx= 'null'

A reference to the MODX object.
Default valuenullDetails
Type
\MODX
Propertypublicarray  $providers= 'array ()'

An array of active providers.
Default valuearray ()Details
Type
array
Propertypublic\modWorkspace  $workspace= 'null'

The active MODX workspace.
Default valuenullDetails
Type
\modWorkspace

Methods

methodpublic__construct( \xPDO $modx ) : \modTransportManager

Creates an instance of the modTransportManager class.

Parameters
Name Type Description
$modx \xPDO

&$modx A reference to a modX instance.

Returns
Type Description
\modTransportManager
methodpublicchangeActiveWorkspace( integer $workspaceId ) : \modWorkspace

Change the active workspace in MODX.

Parameters
Name Type Description
$workspaceId integer

The PK of the modWorkspace.

Returns
Type Description
\modWorkspace
Details
Access
public  
methodpublicgetActiveWorkspace( ) : \modWorkspace

Get the active workspace for the MODX installation.

Returns
Type Description
\modWorkspace
Details
Access
public  
methodpublicgetProviders( boolean $refresh = false ) : array

Get a list of providers for the transports.

Parameters
Name Type Description
$refresh boolean

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

Returns
Type Description
array A list of providers.
Details
Access
public  
methodpublicscanForPackages( ) : array

Scans all providers for a list of packages.

Returns
Type Description
array An array of packages.
Details
Access
public  
methodpublicscanForUpdates( ) : array

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

Returns
Type Description
array An array of updates for packages.
Details
Access
public  
Documentation was generated by DocBlox 0.18.1.