Documentation

Manager
in package
implements ArrayAccess, Countable, IteratorAggregate

Module manager class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.2.0

Table of Contents

Interfaces

ArrayAccess
Countable
IteratorAggregate

Properties

$modules  : array<string|int, mixed>
Modules

Methods

__construct()  : mixed
Constructor
__get()  : mixed
Get a registered module
__isset()  : bool
Determine if a module is registered with the manager object
__set()  : void
Register a module with the manager
__unset()  : void
Unregister a module with the manager
count()  : int
Return count
get()  : mixed
Get a module
getIterator()  : ArrayIterator
Get iterator
getModuleName()  : string
Get a module object's registered name
hasModule()  : bool
Determine if a module object is registered with the manager by $module object comparison
isRegistered()  : bool
Determine if a module object is registered with the manager by $name
offsetExists()  : bool
Determine if a module is registered with the manager object
offsetGet()  : mixed
Get a registered module
offsetSet()  : void
Register a module with the manager
offsetUnset()  : void
Unregister a module with the manager
register()  : static
Register a module object
registerModules()  : static
Register module objects
unregister()  : static
Unregister a module

Properties

$modules

Modules

protected array<string|int, mixed> $modules = []

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $modules = null ]) : mixed

Instantiate the module manager object.

Parameters
$modules : array<string|int, mixed>|null = null
Tags
throws
Exception

__get()

Get a registered module

public __get(string $name) : mixed
Parameters
$name : string

__isset()

Determine if a module is registered with the manager object

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

__set()

Register a module with the manager

public __set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed
Tags
throws
Exception

__unset()

Unregister a module with the manager

public __unset(string $name) : void
Parameters
$name : string

count()

Return count

public count() : int
Return values
int

get()

Get a module

public get(string $name) : mixed
Parameters
$name : string

getIterator()

Get iterator

public getIterator() : ArrayIterator
Return values
ArrayIterator

hasModule()

Determine if a module object is registered with the manager by $module object comparison

public hasModule(ModuleInterface $module) : bool
Parameters
$module : ModuleInterface
Return values
bool

isRegistered()

Determine if a module object is registered with the manager by $name

public isRegistered(string $name) : bool
Parameters
$name : string
Return values
bool

offsetExists()

Determine if a module is registered with the manager object

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

Get a registered module

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

Register a module with the manager

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Tags
throws
Exception

offsetUnset()

Unregister a module with the manager

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

registerModules()

Register module objects

public registerModules(array<string|int, mixed> $modules) : static
Parameters
$modules : array<string|int, mixed>
Tags
throws
Exception
Return values
static

unregister()

Unregister a module

public unregister(string $name) : static
Parameters
$name : string
Return values
static

        
On this page

Search results