Generating DataType Classes

Emvicy includes a Generator that you can use to generate DataType Classes. Consider those Classes more than a Storage than a Logic Element.
Define what name the class and which namespace it should have, which properties or constants it should provide.
Then just run the Generator and it will create the Class for you.

• Configuration
  • Array Notation
  • Object Notation
• Creation
• Note regarding php data types

Configuration

Write your own Configurations.

Place for DataType Generating Configurations; (assuming module Foo)

modules/Foo/etc/config/Foo/config/_datatype.php

Configuration as Array

Example file modules/Foo/etc/config/DataType/datatype.php

<?php

/**
 * @usage php datatype.php
 *          Classes created by this script are placed into folder: `/modules/{module}/DataType/`
 */

#---------------------------------------------------------------
require_once realpath(__DIR__ . '/../../../../../') . '/application/init/util/bootstrap.php';
\MVC\Config::init(get($GLOBALS['aConfig'], array()));
\MVC\Cache::init(\MVC\Config::get_MVC_CACHE_CONFIG());
\MVC\Cache::autoDeleteCache('DataType', 0);

#---------------------------------------------------------------
#  Defining DataType Classes

$sDataTypeDir = realpath(__DIR__ . '/../../../') . '/DataType';
$sNamespace = str_replace('/', '\\', substr($sDataTypeDir, strlen(\MVC\Config::get_MVC_MODULES_DIR() . '/')));

// base setup
$aDataType = array(
    'dir' => $sDataTypeDir,
    'unlinkDir' => false,

    // enable creation of events in datatype methods
    'createEvents' => true,
);

// classes
$aDataType['class'][] = array(
    // ! mandatory
    'name' => 'DTFoo',
    'file' => 'DTFoo.php',

    // optional; no need to even note the key here if not used
    'extends' => '',

    // optional; no need to even note the key here if not used
    'namespace' => \MVC\Config::get_MVC_MODULE_CURRENT_NAME() . '\DataType',

    // optional; add some useful Helper Methods like '__toString()` method (default: true)
    'createHelperMethods' => true,

    // optional; no need to even note the key here if not used
    'constant' => array(
        array(
            'key' => 'FOO',
            'value' => 'BAR',
            'visibility' => 'public'
        )
    ),

    // ! mandatory
    'property' => array(
        array('key' => 'sKey'               , 'var' => 'string'),
        array('key' => 'deliverable'        , 'var' => 'int'),
        array('key' => 'aJsonContext'       , 'var' => 'array'),
        array('key' => 'bSuccess'           , 'var' => 'bool'),
        array(
            'key' => 'foo',
            'var' => 'string', 

            // optional property settings
            'value' => 'bar',
            'forceCasting' => true,
            'visibility' => 'protected'                    
            'static' => false,
            'setter' => true,
            'getter' => true,
            'explicitMethodForValue' => false,
            'listProperty' => true,
            'createStaticPropertyGetter' => true,
            'setValueInConstructor' => true,
        ),
    )
);

#---------------------------------------------------------------
#  create!

\MVC\Generator\DataType::create()->initConfigArray($aDataType);

Configuration as Object

You can also create a DataType class the object way.

Example

// config
$oDTConfig = \MVC\DataType\DTConfig::create()
    ->set_dir(\MVC\Config::get_MVC_MODULES_DIR() . '/' . \MVC\Config::get_MVC_MODULE_CURRENT_NAME() . '/DataType/')
    ->set_unlinkDir(false)
    ->add_DTClass(

        \MVC\DataType\DTClass::create()
            ->set_name('DTFoo')
            ->set_file('DTFoo.php')
            ->set_namespace(\MVC\Config::get_MVC_MODULE_CURRENT_NAME() . '\DataType')
            ->set_createHelperMethods(true)
            ->add_DTConstant(
                \MVC\DataType\DTConstant::create()
                    ->set_key('FOO')
                    ->set_value('"BAR"')
                    ->set_visibility('public')
            )
            ->add_DTProperty(
                \MVC\DataType\DTProperty::create()
                    ->set_key('bSuccess')
                    ->set_var('bool')
                    ->set_value(true)

                    // optional property settings
                    ->set_forceCasting(true)
                    ->set_visibility('protected')
                    ->set_static(false)
                    ->set_setter(true)
                    ->set_getter(true)
                    ->set_listProperty(true)
                    ->set_createStaticPropertyGetter(true)
                    ->set_setValueInConstructor(true)
                    ->set_explicitMethodForValue(false)
            )
    )
;

// generate
$oDTGenerator = \MVC\Generator\DataType::create()->initConfigObject($oDTConfig);

Creation

create DataType class files for your module by executing this command:

creates datatype classes for module Foo

php emvicy datatype:module Foo

create DataType class files for all modules by executing this command:

creates datatype classes for all modules

php emvicy datatype:all

Note regarding php data types

• use bool, not boolean
• use int, not integer