$components
$components : array
The registered \Dewdrop\Admin\ComponentAbstract objects.
This class provides a couple methods that are common to all the admin environments Dewdrop works with.
$session : \Dewdrop\Session
A Dewdrop Session object useful for get flash messenger messages, etc.
$activeComponent : \Dewdrop\Admin\Component\ComponentInterface
The registered active component object.
prependClientSideDependency(string $type, string $name, string $path) : $this
Prepend a client-side dependency you'd like to use throughout the admin environment.
| string | $type | Either "css" or "js". |
| string | $name | An identifier for the dependency. |
| string | $path | The path (in your bower_components folder) to the dependency. |
appendClientSideDependency(string $type, string $name, string $path) : $this
Append a client-side dependency you'd like to use throughout the admin environment.
| string | $type | Either "css" or "js". |
| string | $name | An identifier for the dependency. |
| string | $path | The path (in your bower_components folder) to the dependency. |
addClientSideDependencyAfterKey(string $type, string $name, string $path, string $key) : $this
Add a client-side dependency you'd like to use throughout the admin environment.
| string | $type | Either "css" or "js". |
| string | $name | An identifier for the dependency. |
| string | $path | The path (in your bower_components folder) to the dependency. |
| string | $key | The key of the value you want to put a dependency after. |
setSession(\Dewdrop\Session $session) : $this
Inject a Session object. If you don't provide one, we'll locate it with Pimple, but it's useful to inject during testing.
| \Dewdrop\Session | $session |
setActiveComponent(\Dewdrop\Admin\Component\ComponentInterface $component) : $this
Set a reference to the active component.
| \Dewdrop\Admin\Component\ComponentInterface | $component |
getActiveComponent() : \Dewdrop\Admin\Component\ComponentInterface
Get a reference to the active component.
registerComponentsInPath(string $path = null) : \Dewdrop\Admin\Env\EnvAbstract
Look for and register all admin components in the given path. If no path is provided, the \Dewdrop\Paths->getAdmin() method will be used to find the default admin path for the application.
If no path is given, we'll use the getAdmin() method from \Dewdrop\Paths.
| string | $path |
registerComponentFolder(string $folder, string $classPrefix = '\Admin\\') : \Dewdrop\Admin\Env\EnvAbstract
Register the single admin component located in the supplied path. This can be useful if you want to register individual components that are outside your normal folder for admin components. For example, if you've got some reuseable admin components in a library, or Dewdrop itself, you could register them with this method.
| string | $folder | |
| string | $classPrefix |
registerComponent(\Dewdrop\Admin\Component\ComponentInterface $component) : \Dewdrop\Admin\Env\EnvAbstract
Register an already instantiated component.
| \Dewdrop\Admin\Component\ComponentInterface | $component |
getComponent(string $name) : \Dewdrop\Admin\Component\ComponentInterface
Retrieve a component by name.
| string | $name |
url(\Dewdrop\Admin\Component\ComponentInterface $component, $page, array $params = array())
| \Dewdrop\Admin\Component\ComponentInterface | $component | |
| $page | ||
| array | $params |
initComponent(\Dewdrop\Admin\Component\ComponentInterface $component)
| \Dewdrop\Admin\Component\ComponentInterface | $component |