[keyword] Component

[uml] Helper

Webel module:

UML element type:

OOE stereotypes:

Helper base class with some common static utility methods.

Direct inheritance of this requires at least PHP5.3. Visit also (external tip): Inheritance of static members in PHP.

[uml] FlagPlusFactory

Webel module:

UML element type:

OOE stereotypes:

implements [InterfaceRealization]: 

Default simple factory for common products for this module.

[uml] FlagBannerStateData

Webel module:

UML element type:

OOE stereotypes:

implements [InterfaceRealization]: 

Implements management of data specific to a Flag banner state.

This version is suitable for use for a simple rectangular strip with a text color, background color, and border color. The same data could however be used for other banner designs.

[uml] FlagBanner

REFACTOR: this software engineering content is flagged as under consideration for refactoring.

Webel module:

UML element type:

OOE stereotypes:

implements [InterfaceRealization]: 

Default implementation of a banner specific to a Flag. This version uses a simple rectangular strip.

Note how it stores the data (text color, background color, border color, and style options) for the 2 separate states 'flagged' and 'not flagged' in dedicated state data holders !

[uml] BannerFlagHelper

Webel module:

UML element type:

OOE stereotypes:

Helper class for aspects of banners specific to a Flag. Includes some simple database interaction helper methods.

[uml] EntityFlagMapper

Webel module:

UML element type:

OOE stereotypes:

Manages information on flag applicability by entity type and bundle.

[uml] flagplus.forms.inc

STUB: this content is flagged as a placeholder only, with minimal content.

Webel module:

UML element type:

OOE stereotypes:

A placeholder for non-admin forms and their handlers (and supporting functions). Currently this module has no public-usable forms.

[uml] flagplus.theme.inc

STUB: this content is flagged as a placeholder only, with minimal content.

Webel module:

UML element type:

OOE stereotypes:

A placeholder for theme-related handlers. Currently this module has no theme specific code.

[uml] flagplus.pages.inc

STUB: this content is flagged as a placeholder only, with minimal content.

Webel module:

UML element type:

OOE stereotypes:

A placeholder for public-facing page builders. Currently this module has no public pages.

[uml] flagplus.info

STUB: this content is flagged as a placeholder only, with minimal content.

Webel module:

UML element type:

OOE stereotypes:

Placeholder for the module's .info file.

Extends Flag with some extra features such as the ability to set flag applicability by content type, and CSS styled flag state banners.

[uml] flagplus.install

Webel module:

UML element type:

OOE stereotypes:

[uml] BannerSchema

Webel module:

UML element type:

OOE stereotypes:

Constants common to the database schema of the banner aspects of the module.

So far just enough as an interim step to capture the column names of the DB table used for per-Flag banner settings.

Promotes robust Don't Repeat Yourself (DRY) code rather than error-prone Write Everything Twice (WET) code.

[uml] BybundleAjaxBuilder

REFACTOR: this software engineering content is flagged as under consideration for refactoring.

Webel module:

UML element type:

OOE stereotypes:

extends [Generalization]: 

EXPERIMENTAL: AJAX version of a form for applicability of flags by bundle.

The form it builds has one or more embedded sub-forms for choosing applicability of flags by entity type and bundle (shown according to the entity-type filter choice).

[uml] BybundlePageBuilder

HOT TIP: this content is flagged as highly recommended !

Webel module:

UML element type:

OOE stereotypes:

For building readonly pages of flag applicability by bundle.

[uml] BybundleAbstractBuilder: child hierarchy (and logical grouping wrapper Component example)

HOT TIP: this content is flagged as highly recommended !

Webel module:

UML element type:

OOE stereotypes:

In MagicDraw UML, a Component does not "steal ownership" of a graphically contained child element if the child's SYMBOL is moved/dragged from WITHIN A DIAGRAM into the Component's SYMBOL; it only steals ownerhips if the child model element is moved into (under) the Component WITHIN THE MODEL BROWSER.

[uml] EntityFilter

Webel module:

UML element type:

OOE stereotypes:

A good example of how encapsulating related functions as static helper/builder class methods (that can be reverse engineered to UML) brings immediate advantage to both the code organisation and the UML diagramming, without even considering in detail yet how this might be handled as an object.

This helper/builder class can create both a non-AJAX and an AJAX-aware entity type filter form element, as well as offering some helper functions for the actual filtering against entity type.

[uml] flagplus.entitytype.inc

REFACTOR: this software engineering content is flagged as under consideration for refactoring.
HOT TIP: this content is flagged as highly recommended !

Webel module:

UML element type:

OOE stereotypes:

In migrating from the Drupal7 Island function-and-hook "flatland" to a more OOP and UML-friendly world we endeavour to create "bridge" include files that mediate between the classic Drupal7 hooks of the .module and the OO Class libraries, which progressively encapsulate as class attributes, class constants, and interface/class methods, the data and operations that were in old-style functions.

[uml] flagplus.flags.inc

REFACTOR: this software engineering content is flagged as under consideration for refactoring.
HOT TIP: this content is flagged as highly recommended !

Webel module:

UML element type:

OOE stereotypes:

There is an important IT moral to this story

Don't be discouraged if your UML overview diagrams are at first too complex, that is just your UML model telling you something very important, it is inviting you to refactor your system ! And the way to refactor it is to first identify such "scenarios" in separate diagrams. Later, these might become diagrams for dedicated Classes that correspond to a dedicated narrative.

[uml] BannerHelper

REFACTOR: this software engineering content is flagged as under consideration for refactoring.

Webel module:

UML element type:

OOE stereotypes:

extends [Generalization]: 

This is after some "divide-and-conquer" refactoring. It isolates some Flag Plus data, accessors, and some database methods related to the global Banner settings (stored as system variables), whereas per-Flag Banner settings (stored in a dedicated DB table) are now handled by BannerFlagHelper and IFlagBanner/ FlagBanner.

[uml] flagplus.banners.inc

REFACTOR: this software engineering content is flagged as under consideration for refactoring.

Webel module:

UML element type:

OOE stereotypes:

[uml] flagplus.admin.inc

STUB: this content is flagged as a placeholder only, with minimal content.

Webel module:

UML element type:

OOE stereotypes:

For admin forms and their handlers (and supporting functions). Currently there is only a stub admin welcome page.

For Flag Plus power admin of Flags visit flagplus.flags.inc.

For Flag Plus banners admin visit: flagplus.banners.inc.

[uml] AjaxHelper

Webel module:

UML element type:

OOE stereotypes:

[uml] flagplus.module

Webel module:

UML element type:

OOE stereotypes:

Pages

Subscribe to RSS - Component