Interface IRouter

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public defaults?: any

[Config Option] (Object)

optional public extend?: string

[Config Option] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public platformConfig?: any

[Config Option] (Object)

optional public routes?: Array<any>

[Config Option] (Array)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public connect(url?: string, params?: any)

[Method] Connects a url based route to a controller action pair plus additional params

Parameters

  • url?: string optional

    String The url to recognize.

  • params?: any optional

    Object Additional parameters.

optional public destroy()

[Method]

optional public draw(fn?: any)

[Method] Convenience method which just calls the supplied function with the Router instance

Parameters

  • fn?: any optional

    Function The fn to call

optional public getDefaults(): any

[Method] Returns the value of defaults

Returns

any

Object

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getRoutes(): Array<any>

[Method] Returns the value of routes

Returns

Array<any>

Array

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public recognize(url?: string): any

[Method] Recognizes a url string connected to the Router return the controller action pair plus any additional config associa

Parameters

  • url?: string optional

    String The url to recognize.

Returns

any

Object/undefined If the url was recognized, the controller and action to call, else undefined.

optional public setDefaults(defaults?: any)

[Method] Sets the value of defaults

Parameters

  • defaults?: any optional

    Object

optional public setRoutes(routes?: Array<any>)

[Method] Sets the value of routes

Parameters

  • routes?: Array<any> optional

    Array