Skip to content

Dev.Module Workflow

Jump to bottomEditNew page
Hossein Azizabadi edited this page Nov 16, 2017 · 6 revisions

Module Development Workflow

Step 1: Features and Requirements

1: Feature description

  • Output: text and list

2: Use cases

  • Output: text and list with diagram (MS Visio)
  • [Optional]

3: Flowchart

  • Business
  • System
  • Output: diagram (MS Visio)
  • [Optional]

Step 2: Design

1: System Architecture

  • Output: diagram (MS Visio)
  • Content:
    • The internal architecture of the system
    • The external architecture of the system and other related system
  • [Optional]

2: Controller && Action design

  • Output

    • List

  • List Template

    • IndexController
      • indexAction
        • GET: $param1, $param2, ...
        • POST: $param1, $param2, ...
        • AJAX: No
        • Template: index-index.phtml

3: Block

  • Output

    • List
      • Description
      • Config list
        • Name
        • Type
        • Description
        • Default values

  • List Template

    • RecentUser
      • Description: List recently log in users
      • Configs:
        • list-count
          • Description: total list count
          • Type: text
          • Default values: 40

4: Api design

  • Output

    • List
      • Package
      • Method to Call
      • Description
      • Parameters
      • Return Values
      • Example

  • List Template:

    • Test($name, $options = array())
      • Package: src/Api.php
      • Calling: Pi::service('api')->demo->test($name, $options);
      • Description: Test method
      • Parameters:
        • $name: name
        • $options: optional parameters
      • Return Values: boolean
      • Examples:

    $result = Pi::service('api')->demo->test('test);

5: Main Program Logical Flowchart

  • Output: diagram (MS Visio)

6: Database Design

  • Output

    • Table
      • Name
      • Type
      • Length
      • Default value
      • Description
    • Tables relationship
      • Tools: Workbench

  • Scheme sample:

# Pi Engine schema
# http://piengine.org
# Author: Taiwen Jiang <taiwenjiang@tsinghua.org.cn>
# --------------------------------------------------------
# ------------------------------------------------------
# User
# >>>>
# Entity meta for custom user profile fields
CREATE TABLE `{profile}` (
`id` int(10) unsigned NOT NULL auto_increment,
`uid` int(10) unsigned NOT NULL,
-- Custom profile field
PRIMARY KEY (`id`),
UNIQUE KEY `uid` (`uid`)
);
# Entity for user profile compound fields
CREATE TABLE `{compound}` (
`id` int(10) unsigned NOT NULL auto_increment,
`uid` int(10) unsigned NOT NULL,
-- Compound name, stored in table `field`
`compound` varchar(64) NOT NULL,
-- Field set key, integer
`set` smallint(5) unsigned NOT NULL default '0',
-- Compound field name, stored in table `compound_field`
`field` varchar(64) NOT NULL,
`value` text,
PRIMARY KEY (`id`),
UNIQUE KEY `field` (`uid`, `compound`, `set`, `field`)
);
# Entity meta for all profile fields: account, basic profile and custom fields
CREATE TABLE `{field}` (
`id` smallint(5) unsigned NOT NULL auto_increment,
`name` varchar(64) NOT NULL,
`module` varchar(64) NOT NULL default '',
`title` varchar(255) NOT NULL default '',
-- Specs for edit form element, filters and validators, encoded with json
`edit` text,
-- Filter for display value
`filter` text,
-- Handler for custom compound
`handler` text,
-- Field type, default as 'profile'
`type` enum('profile', 'account', 'compound') NOT NULL,
-- Is editable by user
`is_edit` tinyint(1) unsigned NOT NULL default '0',
-- Is capable for searching user
`is_search` tinyint(1) unsigned NOT NULL default '0',
-- Available for display
`is_display` tinyint(1) unsigned NOT NULL default '0',
-- Required by profile edit
`is_required` tinyint(1) unsigned NOT NULL default '0',
-- Available, usually set by module activation/deactivation
`active` tinyint(1) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`)
);
# Entity meta for compound fields and custom compound fields
CREATE TABLE `{compound_field}` (
`id` smallint(5) unsigned NOT NULL auto_increment,
`name` varchar(64) NOT NULL,
`compound` varchar(64) NOT NULL,
`module` varchar(64) NOT NULL default '',
`title` varchar(255) NOT NULL default '',
`edit` text,
`filter` text,
-- Required by profile edit
`is_required` tinyint(1) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`compound`, `name`)
);
# Display group for profile fields
CREATE TABLE `{display_group}` (
`id` int(10) unsigned NOT NULL auto_increment,
`title` varchar(255) NOT NULL default '',
`order` smallint(5) unsigned NOT NULL default '0',
-- Compound name;
`compound` varchar(64) default NULL,
PRIMARY KEY (`id`)
);
# Display grouping and order of field
CREATE TABLE `{display_field}` (
`id` int(10) unsigned NOT NULL auto_increment,
-- Profile field name;
-- Or compound field name if `compound` is specified in table 'display_group'
`field` varchar(64) NOT NULL default '',
`group` int(10) unsigned NOT NULL default '0',
`order` smallint(5) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `group_field` (`group`, `field`)
);
# Timeline meta
CREATE TABLE `{timeline}` (
`id` int(10) unsigned NOT NULL auto_increment,
`name` varchar(64) NOT NULL default '',
`title` varchar(255) NOT NULL default '',
`module` varchar(64) NOT NULL default '',
`icon` varchar(255) NOT NULL default '',
`app_key` varchar(32) NOT NULL default '',
`active` tinyint(1) NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`, `app_key`)
);
# Activity meta
CREATE TABLE `{activity}` (
`id` int(10) unsigned NOT NULL auto_increment,
`name` varchar(64) NOT NULL default '',
`title` varchar(255) NOT NULL default '',
`description` text,
`module` varchar(64) NOT NULL default '',
-- Render template
`template` varchar(255) NOT NULL default '',
`icon` varchar(255) NOT NULL default '',
`active` tinyint(1) unsigned NOT NULL default '0',
-- Display order, '0' for hidden
`display` smallint(5) unsigned NOT NULL default '0',
-- Callback to get user activity data
`callback` varchar(64) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`)
);
# Quicklinks
CREATE TABLE `{quicklink}` (
`id` int(10) unsigned NOT NULL auto_increment,
`name` varchar(64) NOT NULL default '',
`title` varchar(255) NOT NULL default '',
`module` varchar(64) NOT NULL default '',
`link` varchar(255) NOT NULL default '',
`icon` varchar(255) NOT NULL default '',
`active` tinyint(1) unsigned NOT NULL default '0',
-- Display order, '0' for hidden
`display` smallint(5) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`)
);
# Timeline for user activities
CREATE TABLE `{timeline_log}` (
`id` int(10) unsigned NOT NULL auto_increment,
`uid` int(10) unsigned NOT NULL,
-- Timeline name, defined in table `timeline`
`timeline` varchar(64) NOT NULL default '',
`module` varchar(64) NOT NULL default '',
`message` text,
`link` varchar(255) NOT NULL default '',
`time` int(11) unsigned NOT NULL,
PRIMARY KEY (`id`),
KEY (`uid`)
);
#Privacy setting
CREATE TABLE `{privacy}` (
`id` int(10) unsigned NOT NULL auto_increment,
`field` varchar(64) NOT NULL default '',
-- Default access level: 0 - everyone/public; 1 - member; 2 - follower; 4 - following; 255 - owner
`value` smallint(5) unsigned NOT NULL default '0',
-- Is forced by admin
`is_forced` tinyint(1) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `field` (`field`)
);
#Privacy setting for user profile field
CREATE TABLE `{privacy_user}` (
`id` int(10) unsigned NOT NULL auto_increment,
`uid` int(10) unsigned NOT NULL,
`field` varchar(64) NOT NULL default '',
-- Access level: 0 - everyone/public; 1 - member; 2 - follower; 4 - following; 255 - owner
`value` smallint(5) unsigned NOT NULL default '0',
PRIMARY KEY (`id`),
UNIQUE KEY `user_field` (`uid`, `field`)
);
# User action log generated for user module
CREATE TABLE `{log}` (
`id` int(10) unsigned NOT NULL auto_increment,
`uid` int(10) unsigned NOT NULL,
`time` int(10) unsigned NOT NULL default '0',
`data` varchar(255) NOT NULL default '',
`action` varchar(64) NOT NULL default '',
PRIMARY KEY (`id`),
KEY (`uid`)
);

7: System Component

  • Output: list
  • Content: the special system resource used

8: Config design

  • Output

    • List
      • Name
      • Title
      • Description
      • Category
      • Type
      • Default value

  • List Template:

    • max-list-per-page
      • Title: item count
      • Description: max list count per page
      • Category: general
      • Type: text
      • Default value: 40

Step 3: Coding

1: Basic coding

2: Install

3: Complete business logic

4: Template integrated

Step 4: QA

1: Functional testing

2: Performance testing

  • AB
  • Concurrency testing
  • Code execute time
  • DB fetching count
  • etc

3: Security testing

  • SQL Injection
  • Escape
  • etc

hiii 2

Add a custom sidebar

Clone this wiki locally