core/model/modx/transport/modtransportmanager.class.php
Show:
inherited
inherited
Classes
- Package
- modx
- Subpackage
- transport
\modTransportManager
Package: modx\transport
Properties
array
$config= 'array ()'
The configuration array for the TransportManager.
Default value
array ()Details- Type
- array
\MODX
$modx= 'null'
A reference to the MODX object.
Default value
nullDetails- Type
- \MODX
array
$providers= 'array ()'
An array of active providers.
Default value
array ()Details- Type
- array
\modWorkspace
$workspace= 'null'
The active MODX workspace.
Default value
nullDetails- Type
- \modWorkspace
Methods
__construct(
\xPDO $modx
)
:
\modTransportManagerCreates an instance of the modTransportManager class.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $modx | \xPDO | &$modx A reference to a modX instance. |
| Type | Description |
|---|---|
| \modTransportManager |
changeActiveWorkspace(
integer $workspaceId
)
:
\modWorkspaceChange the active workspace in MODX.
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $workspaceId | integer | The PK of the modWorkspace. |
| Type | Description |
|---|---|
| \modWorkspace |
- Access
- public
getActiveWorkspace(
)
:
\modWorkspaceGet the active workspace for the MODX installation.
Returns
Details
| Type | Description |
|---|---|
| \modWorkspace |
- Access
- public
getProviders(
boolean $refresh
=
false
)
:
arrayGet a list of providers for the transports.
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $refresh | boolean | If true, refresh the list of providers. Defaults to false. |
| Type | Description |
|---|---|
| array | A list of providers. |
- Access
- public
scanForPackages(
)
:
arrayScans all providers for a list of packages.
Returns
Details
| Type | Description |
|---|---|
| array | An array of packages. |
- Access
- public
scanForUpdates(
)
:
arrayScans all providers for a list of updates for all packages.
Returns
Details
| Type | Description |
|---|---|
| array | An array of updates for packages. |
- Access
- public