Using the super class

Overview

Preside comes with its own suite of service objects that you can use in your application just like any of your application's own service objects. In order to make it easy to access the most common core services, we created the Preside Super Class that can be injected into your service objects simply by adding the @presideService annotation to your service CFC file:

/**
 * @presideService
 */
component {

    function init() {
        return this;
    }

    // ...
}
// or
component presideService {

    function init() {
        return this;
    }

    // ...
}

Usage

Once your service has been flagged as being a "Preside Service", it will instantly have a number of core methods available to it such as $getPresideObject() and $isFeatureEnabled(). e.g.

public boolean function updateProfilePicture( required string pictureFilePath ) {
    if ( $isWebsiteUserLoggedIn() && !$isWebsiteUserImpersonated() ) {
        return $getPresideObject( "website_user" ).updateData(
              id   = $getWebsiteLoggedInUserId()
            , data = { profile_picture = arguments.pictureFilePath }
        );
    }

    return false;
}

Helpers

As of 10.11.0, service components using the Preside Super Class have a $helpers object available to them. This object contains all the Coldbox helper UDFs defined in Preside, your application and any extensions you have installed. For example, you can now make use of the isTrue() helper with:

/**
 * @presideService true
 * @singleton      true
 */
component {
    function init() {
        return this;
    }

    function someMethod( required any someArg ) {
        if ( $helpers.isTrue( someArg ) ) {
            // do something
        }
    }
}

Full reference

For a full reference of all the methods available, see Preside Super Class.