Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_iModComponent interface

• Introduction

Module component action controller interface.

• Interface synopsis

AMI_iModComponent {
/* Methods */
// Returns component type.
public getType ( ) returns string;
// Returns component view.
public getView ( ) returns AMI_View;
// Initialization.
public init ( ) returns AMI_iModComponent;
// Returns TRUE if component needs to be started always in full environment.
public isFullEnv ( ) returns bool;
// Sets root serial id.
public setModId ( mixed $modId, string $serialId ) returns AMI_iModComponent;
// Sets unique component id.
public setSerialId ( string $serialId ) returns AMI_iModComponent;
}

• Interface Details

Use AMI_ModComponent children, interface usage will be described later.
Tags:
see AMI_ModComponent
todo Describe usage
since 5.12.0

• Interface Methods

// Returns component type.
public getType ( ) returns string;
  Example:
  •  // AMI_ModFilter::getType()
  •  public function getType(){
  •      return 'form_filter';
  •  }
  •  // AMI_ModList::getType()
  •  public function getType(){
  •      return 'list';
  •  }
  •  // AMI_ModForm::getType()
  •  public function getType(){
  •      return 'form';
  •  }
Tags:
todo Rename to avoid problems from pm#4251?
// Returns component view.
public getView ( ) returns AMI_View;
// Initialization.
public init ( ) returns AMI_iModComponent;
Tags:
see AMI_Mod::init()
// Returns TRUE if component needs to be started always in full environment.
public isFullEnv ( ) returns bool;
// Sets root serial id.
public setModId ( mixed $modId, string $serialId ) returns AMI_iModComponent;
  • string $serialId
    Serial id
Tags:
see AMI_ModComponent::addSubComponent()
todo Detect necessity
// Sets unique component id.
public setSerialId ( string $serialId ) returns AMI_iModComponent;
  • string $serialId
    Serial id