Scoping Process

The scoping process must be done by using some of the referenced injector's methods:
buildInstance(mapping, initArguments)
autowire()
These methods must be called sequentially in order to avoid circular reference locks. The first method buildInstance is used to construct and initialize an object instance. The autowire method is used then to process DI and AOP on the targeted object. Let's look at my Ortus Scope:
1
<cfcomponent output="false" implements="wirebox.system.ioc.scopes.IScope" hint="I am the Ortus Scope of Scopes">
2
​
3
    <---  init --->
4
    <cffunction name="init" output="false" access="public" returntype="any" hint="Configure the scope for operation">
5
        <cfargument name="injector" type="any" required="true" hint="The linked WireBox injector" colddoc:generic="wirebox.system.ioc.Injector"/>
6
        <cfscript>
7
            instance = {
8
                injector = arguments.injector,
9
                ortus = {}
10
            };
11
            return this;
12
        </cfscript>
13
    </cffunction>
14
​
15
    <---  getFromScope --->
16
    <cffunction name="getFromScope" output="false" access="public" returntype="any" hint="Retrieve an object from scope or create it if not found in scope">
17
        <cfargument name="mapping"             type="any" required="true"  hint="The object mapping" colddoc:generic="wirebox.system.ioc.config.Mapping"/>
18
        <cfargument name="initArguments"     type="any" required="false" hint="The constructor structure of arguments to passthrough when initializing the instance" colddoc:generic="struct"/>
19
        <cfscript>
20
            var name = arguments.mapping.getName();
21
            if( structKeyExists(instance.ortus, name) ){
22
                return instance.ortus[name];
23
            }
24
​
25
            lock name="ortus.scope.#arguments.mapping.getName()#"{
26
                instance.ortus[name] = instance.injector.buildInstance( arguments.mapping, arguments.initArguments );
27
            }
28
​
29
            // wire it
30
            instance.injector.autowire(target=instance.ortus[name],mapping=arguments.mapping);
31
​
32
            // send it back
33
            return instance.ortus[name];
34
        </cfscript>
35
    </cffunction>
36
​
37
</cfcomponent>
Copied!
Caution Always make sure that you use the buildInstance method and then store the results in the scope before wiring is done to avoid endless loops errors.

The Scope Interface

Registering a Custom Scope

Copy link