Namespace ICanBoogie

Namespaces summary

ICanBoogie\ActiveRecord
ICanBoogie\AutoConfig
ICanBoogie\CLDR
ICanBoogie\Composer
ICanBoogie\Core
ICanBoogie\Event
ICanBoogie\Exception
ICanBoogie\HTTP
ICanBoogie\I18n
ICanBoogie\Mailer
ICanBoogie\Modules
ICanBoogie\Object
ICanBoogie\Operation
ICanBoogie\Prototype
ICanBoogie\Routes
ICanBoogie\Routing
ICanBoogie\Session

Classes summary

ActiveRecord	Active Record faciliates the creation and use of business objects whose data require persistent storage via database.
Cache
Configs	This class provides an accessor to synthesized low level configurations.
Core	Core of the framework.
DateTime	Representation of a date and time.
Debug
DeleteOperation	Deletes a record.
Errors	An error collector.
Event	An event.
EventHook	An event hook.
Events	Events collected from the "hooks" config or attached by the user.
FileCache
FormattedString
Helpers	Patchable helpers of the ICanBoogie package.
I18n
Image
Inflections	A representation of the inflections used by an inflector.
Inflector	The Inflector transforms words from singular to plural, class names to table names, modularized class names to ones without, and class names to foreign keys. Inflections can be localized, the default english inflections for pluralization, singularization, and uncountable words are kept in `lib/inflections/en.php`.
Models	Models manager.
Module	A module of the framework.
Modules	Modules manager.
Object	Together with the `ICanBoogie\Prototype` class the `ICanBoogie\Object` class provides means to define getters and setters, as well as define getters, setters, and method at runtime.
Operation	An operation.
PingOperation	Keeps the user's session alive.
Prototype	Subclasses of the `ICanBoogie\Object` class are associated with a prototype, which can be used to add methods as well as getters and setters to classes.
Route	A route.
Routes	The route collection.
SaveOperation	The "save" operation is used to create or update a record.
Session	Session.
TimeZone	Representation of a timezone.
TimeZoneLocation	Representation of a time zone location.
Uploaded
Vars	Accessor for the variables stored as files in the "/repository/var" directory.
VarsIterator	Iterates through variables.

Interfaces summary

StorageInterface
ToArray
ToArrayRecursive

Traits summary

PrototypeTrait
ToArrayRecursiveTrait

Exceptions summary

AlreadyAuthenticated	Exception thrown when the user is already authenticated.
AuthenticationRequired	Exception thrown when user authentication is required.
Exception
ModuleConstructorMissing	Exception thrown when a class is missing to instantiate a module.
ModuleIsDisabled	Exception thrown when a disabled module is requested.
ModuleNotDefined	Exception thrown when a requested module is not defined.
OffsetError	Exception thrown when there is something wrong with an array offset.
OffsetNotDefined	Exception thrown when an array offset is not defined.
OffsetNotReadable	Exception thrown when an array offset is not readable.
OffsetNotWritable	Exception thrown when an array offset is not writable.
PermissionRequired	Exception thrown when a user doesn't have the required permission.
PropertyError	Exception thrown when there is something wrong with an object property.
PropertyIsReserved	Exception thrown when a property has a reserved name.
PropertyNotDefined	Exception thrown when a property is not defined.
PropertyNotReadable	Exception thrown when a property is not readable.
PropertyNotWritable	Exception thrown when a property is not writable.
RouteNotDefined	Exception thrown when a route does not exists.
SecurityException	Exception thrown when a security error occurs.

Constants summary

TOKEN_ALPHA
TOKEN_ALPHA_UPCASE
TOKEN_NUMERIC
TOKEN_SYMBOL
TOKEN_SYMBOL_WIDE

Functions summary

array_flatten	Flattens an array.
array_insert	Inserts a value in a array before, or after, a given key.
array_merge_recursive	Merge arrays recursively with a different algorithm than PHP.
camelize	Forwards calls to `Inflector::get()->camelize()`.
capitalize
downcase
dump	Returns information about a variable.
escape	Escape HTML special characters.
escape_all	Escape all applicable characters to HTML entities.
exact_array_merge_recursive
excerpt	Creates an excerpt of an HTML string.
format	Formats the given string by replacing placeholders with the values provided.
generate_token	Generate a password.
generate_token_wide	Generate a 512 bit (64 chars) length token from TOKEN_WIDE.
generate_v4_uuid	Generates a v4 UUID.
get_autoconfig	Returns the auto-config.
humanize	Forwards calls to `Inflector::get()->humanize()`.
hyphenate	Forwards calls to `Inflector::get()->hyphenate()`.
log	Logs a message.
log_error	Logs an error message.
log_info	Logs an info message.
log_success	Logs a success message.
log_time	Logs a debug message associated with a timing information.
normalize	Normalizes a string.
normalize_namespace_part	Normalize a string to be suitable as a namespace part.
normalize_url_path	Normalizes the path of a URL.
pbkdf2	PBKDF2 Implementation (described in RFC 2898)
pluralize	Forwards calls to `Inflector::get()->pluralize()`.
remove_accents	Removes the accents of a string.
shorten	Shortens a string at a specified position.
singularize	Forwards calls to `Inflector::get()->singularize()`.
sort_by_weight	Sort an array according to the weight of its items.
stable_sort	Sorts an array using a stable sorting algorithm while preserving its keys.
strip_root	Removes the `DOCUMENT_ROOT` from the provided path.
titleize	Forwards calls to `Inflector::get()->titleize()`.
unaccent_compare	Binary-safe case-sensitive accents-insensitive string comparison.
unaccent_compare_ci	Binary-safe case-insensitive accents-insensitive string comparison.
underscore	Forwards calls to `Inflector::get()->underscore()`.
upcase