MythCore Files

MythCore-Data v0.1.0.3-alpha

MythCore-Data Alpha Preview Release v0.1.0.3 Data access components for the MythCore framework

This is the first alpha-level release of the MythCore Data components (packages as they are called in MythCore)

Although this release is only meant to serve as a showcase of the framework's style, it is usable on its own right.

The Package consists simply of the Following:

Core Directory

• Core.php - this file is included in all MythCore Packages and distributions. It contains the most essential classes of the framework: ** IObject interface, Object Class - Bases of all classes and interfaces in the framework ** CoreConfig, U - configuration and utility classes ** IClassLoader, ClassLoaderBase, CoreLoader - bases for class loader in general and the MythCore class loader. These mainly remove the need for require and require_once hell.
• Config.inc - Sets framework-wide configurations such as debug mode and the root folder. If you install the Core folder into any other directory than the root of your application, change the setting in this file CoreConfig::Instance()->BasePath(U::DocRoot()). For example, if you installed the Core folder into a folder myth/core/Core in your root application folder, you will set this as follows: CoreConfig::Instance()->BasePath(U::DocRoot() . 'myth/core')
• Enum.php - The Enum class file, base of all "enumerations" in the framework (we call them that, but they're not your typical C enum)
• Data Directory - This is where all the Data classes live. Simply, it includes the following class files: ** IConnection, ICommand, IDataRecord, IDataReader, IQueryResult - interfaces common to all data access classes, whether the ones implemented in this release or future planned ones. It also sets a common-practice to be followed by implementors. ** FieldType, CommandType enumerations - used by classes and interfaces within the module/package ** FieldInfo - data structure to hold information about data fields in a data record (the columns). ** DataResultObject - the default class for data objects returned by ReadObject methods of data readers if no custom class was provided to the method. It simply takes the data record and allows access to it using object notation: $obj->Name instead of array notation ** DataRecordBase - base class for data readers and data records which allows access to the data within a record using array style (both numeric and associative) and object notation. ** Db Directory - classes and interfaces related to database access. Note that the future plan for the MythCore-Data package includes supporting data access to Xml, Json data stores at least. *** IDbConnection, DbConnectionBase - bases for database connection classes *** MySql Directory - contains implementation for the core data classes for the MySql database provider. Implementation currently relies on mysqli **** DbConnection, DbCommand, DbQueryResult, DbReader - the main classes of the provider

Other files * When you extract the files in any of the packages, it will have a Core directory and a Core.inc file outside of it. This is the file you include or require to add support for the framework or this part of the framework * If you downloaded the package with the tests, there will be also a Test folder and an .htaccess files. An index.php is there so that if you extracted everything into the document root of a server, visit the root and it will guide you through the ssingle test that's there. Those files are not documented yet and are a sneak peak into other features of the framework