README

This tool simplifies user's work on using WCMS WebService to manipulate assets.

Asset types supported

Before operating any asset, a WCMS SOAP client should initiated with url to WSDL, site name, and api key:

$wcms = new WCMSClient($wsdl, $sitename);
$wcms->setAuthByKey($apikey);

Block: Data Definition

Read

$pathToBlock = "/Settings";
$block = new BlockXHTML($wcms, $pathToBlock);
var_dump($block->oldAsset);

Update

Create

$assetPayload = [];
//required
$assetPayload['structuredData'] = [
    'definitionPath' => 'path-to-data-definition',
    // OR
    //'definitionId' => 'data definition id'
];
//OR required
//$assetPayload['xhtml'] = '';
//required
$assetPayload['parentFolderPath'] = "path-to-parent-folder";
//OR required
//$assetPayload['parentFolderId'] = "parent-folder-id";
$assetPayload['name'] = "asset-name";
$assetPayload = (object) $assetPayload;
$block = new BlockXHTML($wcms);
$block->setNewAsset($assetPayload);
$block->createAsset();

Delete

Block: Index

Block: Feed

Block: Text

File

Folder

Content Type

Asset Factory

Data Definition

Format: Velocity

Symlink

Template

How-To

When creating new asset, how to check if new asset is created or the asset already exists?

By checking if $asset->oldAsset attribute is set and $asset->newAsset has a $id key set

if $asset->getOldAsset() returns null, or $asset->getNewAsset()->id is set, a new asset has been created by createAsset()
if $asset->getOldAsset() returns asset data or $asset->getNewAsset()->id is Not set, the asset meant to be created has already existed.

iu-webtech / wcms-generic-tool

Maintainers

Details