Index | Data Manager API

A

LoadsFilesInterface::addDecoder() — Method in class LoadsFilesInterface: Allows for the addition of a custom decoder to load custom files.
ManagesItemsInterface::add() — Method in class ManagesItemsInterface: Adds a single item.
ManagesItemsInterface::all() — Method in class ManagesItemsInterface: Return all items as array Alias of getAll()
FileLoader::addDecoder() — Method in class FileLoader: Add a file decoder to the FileLoader
FileLoader::addFiles() — Method in class FileLoader: Add a file bag, or change an array of SplFileInfo Objects to proper objects.
ArrayableTrait — Class in namespace Michaels\Manager\Traits: Class ArrayableTrait
DependsOnManagesItemsTrait::add() — Method in class DependsOnManagesItemsTrait: Adds a single item.
DependsOnManagesItemsTrait::all() — Method in class DependsOnManagesItemsTrait: Return all items as array Alias of getAll()
LoadsFilesTrait::addDecoder() — Method in class LoadsFilesTrait: Allows for the addition of a custom decoder to the manager load files system.
ManagesIocTrait::add() — Method in class ManagesIocTrait: Adds a dependency to the manager
ManagesItemsTrait::add() — Method in class ManagesItemsTrait: Adds a single item.
ManagesItemsTrait::all() — Method in class ManagesItemsTrait: Return all items as array Alias of getAll()

B

BasicManager — Class in namespace Michaels\Manager: Manages deeply nested, complex data.
BadFileDataException — Class in namespace Michaels\Manager\Exceptions: BadFileDataException - used, when file data being added to the loaded is not compatible.
BadFileInfoObjectException — Class in namespace Michaels\Manager\Exceptions: SerializationTypeNotSupportedException

C

ConfigManager — Class in namespace Michaels\Manager: Manages deeply nested, complex data.
ChainsNestedItemsInterface — Class in namespace Michaels\Manager\Contracts: Contract for Managers that use magic methods to burrow into the item store See src/Traits/ChainsNestedItemsTrait.php for implementation example.
ManagesItemsInterface::clear() — Method in class ManagesItemsInterface: Clear the manager
CustomXmlDecoder — Class in namespace Michaels\Manager\Decoders: This is just a simple XML decoder for test purposes.
ArrayableTrait::count() — Method in class ArrayableTrait
ChainsNestedItemsTrait — Class in namespace Michaels\Manager\Traits: Access Deeply nested manager items through magic methods
CollectionTrait — Class in namespace Michaels\Manager\Traits: Access Deeply nested manager items through magic methods
DependsOnManagesItemsTrait::clear() — Method in class DependsOnManagesItemsTrait: Clear the manager
ManagesItemsTrait::clear() — Method in class ManagesItemsTrait: Clear the manager

D

ChainsNestedItemsInterface::drop() — Method in class ChainsNestedItemsInterface: Deletes item at the current level of nesting (and below)
DecoderInterface — Class in namespace Michaels\Manager\Contracts: Contract for Decoders
DecoderInterface::decode() — Method in class DecoderInterface: This is the method, which does the decoding work.
CustomXmlDecoder::decode() — Method in class CustomXmlDecoder: This is the method, which does the decoding work.
JsonDecoder::decode() — Method in class JsonDecoder: Decodes JSON data to array
PhpDecoder::decode() — Method in class PhpDecoder: This is the method, which does the decoding work.
YamlDecoder::decode() — Method in class YamlDecoder: This is the method, which does the decoding work.
FileLoader::decodeFileBagData() — Method in class FileLoader: Process file bag to load into the data manager.
ChainsNestedItemsTrait::drop() — Method in class ChainsNestedItemsTrait: Deletes item at the current level of nesting (and below)
DependsOnManagesItemsTrait — Class in namespace Michaels\Manager\Traits

E

FileBag::emptyBag() — Method in class FileBag: Reset the FileBag back to an empty array.
ManagesItemsInterface::exists() — Method in class ManagesItemsInterface: Confirm or deny that an item exists
DependsOnManagesItemsTrait::exists() — Method in class DependsOnManagesItemsTrait: Confirm or deny that an item exists
ManagesItemsTrait::exists() — Method in class ManagesItemsTrait: Confirm or deny that an item exists

F

FileBag — Class in namespace Michaels\Manager\Bags: Class FileBag - a collection object needed to create SplFileInfo objects from file references, in order to inject into the FileLoader. This collection class can only store SplFileInfo objects. Anything else will cause exceptions.
FileLoader — Class in namespace Michaels\Manager: Loads configuration files and converts them to php arrays using Decoders
ManagesIocTrait::fetch() — Method in class ManagesIocTrait: Alias of get() for backwards comparability

G

FileBag::getAllFileInfoObjects() — Method in class FileBag: Return an array of SplFileInfo objects
DecoderInterface::getMimeType() — Method in class DecoderInterface: The data returned is the actual file extensions supported for the files to decode.
IocContainerInterface::get() — Method in class IocContainerInterface: Returns the request object with all dependencies
ManagesItemsInterface::get() — Method in class ManagesItemsInterface: Get a single item
ManagesItemsInterface::getIfExists() — Method in class ManagesItemsInterface: Return an item if it exist
ManagesItemsInterface::getIfHas() — Method in class ManagesItemsInterface: Return an item if it exist Alias of getIfExists()
ManagesItemsInterface::getAll() — Method in class ManagesItemsInterface: Return all items as array
CustomXmlDecoder::getMimeType() — Method in class CustomXmlDecoder: The data returned is the actual file extensions supported for the files to decode.
JsonDecoder::getMimeType() — Method in class JsonDecoder: Returns MimeType
PhpDecoder::getMimeType() — Method in class PhpDecoder: The data returned is the actual file extensions supported for the files to decode.
YamlDecoder::getMimeType() — Method in class YamlDecoder: The data returned is the actual file extensions supported for the files to decode.
FileLoader::getFileContents() — Method in class FileLoader: Returns the contents of the file.
FileLoader::getDecoders() — Method in class FileLoader: Returns currently attached custom decoders
FileLoader::getMimeTypes() — Method in class FileLoader: Returns currently supported Mime Types
Helpers::getArrayableItems() — Method in class Helpers: Results array of items from Collection or Arrayable.
NoItemFoundMessage::getMessage() — Method in class NoItemFoundMessage: Returns the message
ArrayableTrait::getIterator() — Method in class ArrayableTrait
DependsOnManagesItemsTrait::get() — Method in class DependsOnManagesItemsTrait: Get a single item
DependsOnManagesItemsTrait::getIfExists() — Method in class DependsOnManagesItemsTrait: Return an item if it exist
DependsOnManagesItemsTrait::getIfHas() — Method in class DependsOnManagesItemsTrait: Return an item if it exist Alias of getIfExists()
DependsOnManagesItemsTrait::getAll() — Method in class DependsOnManagesItemsTrait: Return all items as array
LoadsFilesTrait::getFileLoader() — Method in class LoadsFilesTrait
ManagesIocTrait::get() — Method in class ManagesIocTrait: Returns the request object with all dependencies
ManagesItemsTrait::get() — Method in class ManagesItemsTrait: Get a single item
ManagesItemsTrait::getRaw() — Method in class ManagesItemsTrait: Get a single item
ManagesItemsTrait::getIfExists() — Method in class ManagesItemsTrait: Return an item if it exist
ManagesItemsTrait::getIfHas() — Method in class ManagesItemsTrait: Return an item if it exist Alias of getIfExists()
ManagesItemsTrait::getAll() — Method in class ManagesItemsTrait: Return all items as array
ManagesItemsTrait::getItemsName() — Method in class ManagesItemsTrait: Returns the name of the property that holds data items

H

ManagesItemsInterface::hydrate() — Method in class ManagesItemsInterface: Hydrate with external data, optionally append
ManagesItemsInterface::has() — Method in class ManagesItemsInterface: Confirm or deny that an item exists Alias of exists()
Helpers — Class in namespace Michaels\Manager: Class Helpers
DependsOnManagesItemsTrait::hydrate() — Method in class DependsOnManagesItemsTrait: Hydrate with external data, optionally append
DependsOnManagesItemsTrait::has() — Method in class DependsOnManagesItemsTrait: Confirm or deny that an item exists Alias of exists()
ManagesItemsTrait::hydrate() — Method in class ManagesItemsTrait: Hydrate with external data, optionally append
ManagesItemsTrait::has() — Method in class ManagesItemsTrait: Confirm or deny that an item exists Alias of exists()

I

IocContainerInterface — Class in namespace Michaels\Manager\Contracts: Contract for Manager instances that return prepared data Does NOT include methods for managing dependencies
IocManagerInterface — Class in namespace Michaels\Manager\Contracts: Contract for Manager instances that manage dependencies
ManagesItemsInterface::initManager() — Method in class ManagesItemsInterface: Initializes a new manager instance.
ManagesItemsInterface::isEmpty() — Method in class ManagesItemsInterface: Confirm that manager has no items
IncorrectDataException — Class in namespace Michaels\Manager\Exceptions: IncorrectDataException
ItemNotFoundException — Class in namespace Michaels\Manager\Exceptions: ItemNotFoundException
Helpers::isArrayable() — Method in class Helpers: Returns true if value can be used as array or traversed.
IocManager — Class in namespace Michaels\Manager: Manages deeply nested, complex data.
DependsOnManagesItemsTrait::initManager() — Method in class DependsOnManagesItemsTrait: Initializes a new manager instance.
DependsOnManagesItemsTrait::isEmpty() — Method in class DependsOnManagesItemsTrait: Confirm that manager has no items
ManagesItemsTrait::initManager() — Method in class ManagesItemsTrait: Initializes a new manager instance.
ManagesItemsTrait::isEmpty() — Method in class ManagesItemsTrait: Confirm that manager has no items

J

JsonDecoder — Class in namespace Michaels\Manager\Decoders: A standard Json Decoder Module for the data manager file loader.
JsonDecodingFailedException — Class in namespace Michaels\Manager\Exceptions: Json Decoding failed
ArrayableTrait::jsonSerialize() — Method in class ArrayableTrait

L

LoadsFilesInterface — Class in namespace Michaels\Manager\Contracts: API Methods for loading file data into the manager
LoadsFilesInterface::loadFiles() — Method in class LoadsFilesInterface: This method adds load file functionality.
LoadsFilesTrait — Class in namespace Michaels\Manager\Traits: Loads data from configuration-type files into Manager
LoadsFilesTrait::loadFiles() — Method in class LoadsFilesTrait: This method adds the file loading functionality.
LoadsFilesTrait::loadFile() — Method in class LoadsFilesTrait
ManagesItemsTrait::loadDefaults() — Method in class ManagesItemsTrait: Merge a set of defaults with the current items

M

ManagesItemsInterface — Class in namespace Michaels\Manager\Contracts: API Methods for managing items
ModifyingProtectedValueException — Class in namespace Michaels\Manager\Exceptions: ModifyingProtectedValueException
Manager — Class in namespace Michaels\Manager: Manages deeply nested, complex data.
$CollectionTrait — Property in class CollectionTrait
ManagesIocTrait — Class in namespace Michaels\Manager\Traits: Manages complex, nested data
ManagesItemsTrait — Class in namespace Michaels\Manager\Traits: Manages complex, nested data

N

NestingUnderNonArrayException — Class in namespace Michaels\Manager\Exceptions: NestingUnderNonArrayException
NoItemFoundMessage — Class in namespace Michaels\Manager\Messages: Class NoItemFoundMessage

O

ArrayableTrait::offsetExists() — Method in class ArrayableTrait
ArrayableTrait::offsetGet() — Method in class ArrayableTrait
ArrayableTrait::offsetSet() — Method in class ArrayableTrait
ArrayableTrait::offsetUnset() — Method in class ArrayableTrait

P

ManagesItemsInterface::push() — Method in class ManagesItemsInterface: Push a value or values onto the end of an array inside manager
PhpDecoder — Class in namespace Michaels\Manager\Decoders: A wrapper for the PHP Decoder Module for the data manager file loader.
FileLoader::process() — Method in class FileLoader: Process the current FileBag and return an array
DependsOnManagesItemsTrait::push() — Method in class DependsOnManagesItemsTrait: Push a value or values onto the end of an array inside manager
ManagesItemsTrait::push() — Method in class ManagesItemsTrait: Push a value or values onto the end of an array inside manager
ManagesItemsTrait::protect() — Method in class ManagesItemsTrait: Guard an alias from being modified

R

ManagesItemsInterface::remove() — Method in class ManagesItemsInterface: Deletes an item
ManagesItemsInterface::reset() — Method in class ManagesItemsInterface: Reset the manager with an array of items Alias of initManager()
$CollectionTrait — Property in class CollectionTrait
$CollectionTrait — Property in class CollectionTrait
DependsOnManagesItemsTrait::remove() — Method in class DependsOnManagesItemsTrait: Deletes an item
DependsOnManagesItemsTrait::reset() — Method in class DependsOnManagesItemsTrait: Reset the manager with an array of items Alias of initManager()
ManagesItemsTrait::remove() — Method in class ManagesItemsTrait: Deletes an item
ManagesItemsTrait::reset() — Method in class ManagesItemsTrait: Reset the manager with an array of items Alias of initManager()

S

IocManagerInterface::share() — Method in class IocManagerInterface: Turns a dependency into a singleton.
IocManagerInterface::setup() — Method in class IocManagerInterface: Add a pipeline to to the que for a specific item
ManagesItemsInterface::set() — Method in class ManagesItemsInterface: Updates an item
SerializationTypeNotSupportedException — Class in namespace Michaels\Manager\Exceptions: SerializationTypeNotSupportedException
FileLoader::sanitizeNamespace() — Method in class FileLoader: Cleans up a file name for use as a namespace
DependsOnManagesItemsTrait::set() — Method in class DependsOnManagesItemsTrait: Updates an item
LoadsFilesTrait::setFileLoader() — Method in class LoadsFilesTrait
ManagesIocTrait::share() — Method in class ManagesIocTrait: Turns a dependency into a singleton.
ManagesIocTrait::setup() — Method in class ManagesIocTrait: Add a pipeline to to the que
ManagesItemsTrait::set() — Method in class ManagesItemsTrait: Updates an item
ManagesItemsTrait::setItemsName() — Method in class ManagesItemsTrait: Sets the name of the property that holds data items

T

ManagesItemsInterface::toJson() — Method in class ManagesItemsInterface: Get the collection of items as JSON.
CollectionTrait::toCollection() — Method in class CollectionTrait: Converts an array to a collection if value is arrayable and config is set
DependsOnManagesItemsTrait::toJson() — Method in class DependsOnManagesItemsTrait: Get the collection of items as JSON.
ManagesItemsTrait::toJson() — Method in class ManagesItemsTrait: Get the collection of items as JSON.

U

UnsupportedFilesException — Class in namespace Michaels\Manager\Exceptions: Class UnsupportedFilesException
$CollectionTrait — Property in class CollectionTrait: Configuration: do we want to return Collections from get() and getAll()?

W

CollectionTrait::wantsCollections() — Method in class CollectionTrait: Does this instance want collections returned from get() and getAll()?

Y

YamlDecoder — Class in namespace Michaels\Manager\Decoders: SerializationTypeNotSupportedException
YmlDecoder — Class in namespace Michaels\Manager\Decoders

_

FileBag::__construct() — Method in class FileBag: Constructs a new FileBag
BasicManager::__construct() — Method in class BasicManager: Build a new manager instance
ConfigManager::__construct() — Method in class ConfigManager: Build a new manager instance
ChainsNestedItemsInterface::__get() — Method in class ChainsNestedItemsInterface: Sets the current level of nesting.
ChainsNestedItemsInterface::__call() — Method in class ChainsNestedItemsInterface: Retrieves a value from the manager at the current nest level.
ChainsNestedItemsInterface::__set() — Method in class ChainsNestedItemsInterface: Sets an item at the current nest level.
ManagesItemsInterface::__toString() — Method in class ManagesItemsInterface: When manager instance is used as a string, return json of items
IocManager::__construct() — Method in class IocManager: Build a new manager instance
Manager::__construct() — Method in class Manager: Build a new manager instance
NoItemFoundMessage::__construct() — Method in class NoItemFoundMessage: Creates a new NoItemFoundMessage
ChainsNestedItemsTrait::__get() — Method in class ChainsNestedItemsTrait: Sets the current level of nesting.
ChainsNestedItemsTrait::__call() — Method in class ChainsNestedItemsTrait: Retrieves a value from the manager at the current nest level.
ChainsNestedItemsTrait::__set() — Method in class ChainsNestedItemsTrait: Sets an item at the current nest level.
CollectionTrait::__call() — Method in class CollectionTrait: Invokes when calling a method on the Collection API
DependsOnManagesItemsTrait::__toString() — Method in class DependsOnManagesItemsTrait: When manager instance is used as a string, return json of items
ManagesItemsTrait::__toString() — Method in class ManagesItemsTrait: When manager instance is used as a string, return json of items