Skip to content

Latest commit

 

History

History
122 lines (92 loc) · 3.49 KB

TUTORIAL_DATA.md

File metadata and controls

122 lines (92 loc) · 3.49 KB
Raw

TUTORIAL - DATA

This tutorial shows you how to create a model and how to use them in your code. NOTE: You may need the architect package to initialize/create your database structure defined in your model definition.

Requirements

  • Model Definition
  • Model Backing Class
  • Your imagination - e.g. a blank context to work in

Files to be touched

  • /config/model/your-schema_your-model.json (create)
  • /backend/class/model/your-model.php (create)
  • /backend/class/context/some-place-to-work-in.php (create/modify)

Step 1: Create your model definition

Create a new json file in config/model/, e.g. demo_stuff.json. It is always _.json. Schema MAY be "demo", but it can also be "abc" or whatever you want it to become. The schema translates to DB Schemata (or, if you're using MySQL, it matches up with a "database"). And yes, you can cross-join them.

{
  "field" : [
    "stuff_id",
    "stuff_created",
    "stuff_modified",
    "stuff_name"
  ],
  "primary" : [
    "stuff_id"
  ],
  "datatype" : {
    "stuff_id" : "number_natural",
    "stuff_created" : "text_timestamp",
    "stuff_modified" : "text_timestamp",
    "stuff_name" : "text"
  },
  "options" : {
    "stuff_name" : {
      length: 64
    }
  },
  "connection" : "myconnection"
}

NOTES:

  • Required keys: field (array of field names / column names) primary (array of fields to be the primary key - should be only 1 (!) at this time) datatype (the core-framework-specific datatypes - one of those: text, number, number_natural, boolean, text, structure, ... - you can even use text_email)
  • Optional keys: foreign (for foreign key definitions) db_column_type (see below) connection (for using a specific db connection defined in environment.json)
  • You may use "db_column_type" to specify the exact database-specific datatype. If undefined for a given key, the default values are used.

Step 2: Build

If you don't want to create the databases, tables, fields and constraints yourself, you should use the Architect to build you definition. You have to have architect installed as a composer package. If you're using the default prepared docker-compose environment, you can open up http://architect.localhost:8080/ to view pending changes. Click on Details of your app. To execute the pending tasks, append the GET-Parameter exec=1 to the url.

Step 3: Create the backing class

Create a new PHP file at backend/class/model/_.json

<?php
namespace codename\demo\model;

/**
 * this is an example model
 * without function
 */
class stuff extends \codename\core\model\schematic\mysql {

  /**
   *
   * {@inheritDoc}
   */
  public function __CONSTRUCT(array $modeldata) {
      parent::__CONSTRUCT($modeldata);
      $this->setConfig(null, 'demo', 'stuff');
  }

}

NOTES:

  • watch the namespace
  • correctly name your class and let it inherit from the right model base class (see above)
  • watch: $this->setConfig(null, '', '');

Step 4: Use!

$model = app::getModel('stuff'); // do your stuff.

NOTES:

  • If you're using app::getModel(), you have to be in the namespace codename\core; (or even your own app namespace). Otherwise, require it using "use \codename\core\app;".
  • If you're working inside a context, you can also use $this->getModel( ... ), as the base context class provides you this method.