\midcom_services_rcs

The RCS service gives a write only interface to different services wanting to save changes to objects.

The RCS service will try to initialize the backend based on GNU RCS, but, if that fails, fall back to the nullrcs handler. The nullrcs handler does not save anything at all.

Configuration parameters that are in use by this service:

string midcom_services_rcs_bin_dir - the prefix for the rcs utilities (normally /usr/bin)
string midcom_services_rcs_root - the directory where the rcs files get placed.
boolean midcom_services_rcs_enable - if set, midcom will fail hard if the rcs service is not operational.

Summary

Methods

Properties

Constants

__construct()
load_handler()
update()
is_field_showable()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$_handlers
$config

N/A

File: lib/midcom/services/rcs/main.php
Package: midcom.services.rcs
Class hierarchy: \midcom_services_rcs

Properties

$_handlers

$_handlers :

Array of handlers that rcs uses to manage object versioning.

Type

$config

$config : \midcom_services_rcs_config

The configuration object for the rcs service.

Type

\midcom_services_rcs_config

Methods

__construct()

__construct(array  $config = null)

Constructor

Parameters

array

$config

the midcom_config

load_handler()

load_handler(  $object) : \midcom_services_rcs_backend

Loads the handler

Parameters

$object

Returns

\midcom_services_rcs_backend

update()

update(object  $object, string  $message = null)

Create or update the RCS file for the object.

Parameters

object	$object	the midgard object to be saved
string	$message	the update message to save (optional)

is_field_showable()

is_field_showable(  $field)

Determine if we should display a particular field in the diff or preview states

Parameters

$field