Jet\Application_Service_MetaInfo

The class represents service metadata within the application services subsystem.

This metadata is always present on an interface or an abstract class describing the interface of the given service.

Method Meaning
public __construct(
string $group='',
bool $is_mandatory=false,
bool $multiple_mode=false,
string $name='',
string $description='',
string $module_name_prefix=''
)
Parameters:
  • $group String identification of the service group to which the service belongs.
  • $is_mandatory Indicates whether the service is mandatory – i.e., whether the application must contain an application module providing this service.
  • $multiple_mode Indicates whether the given service can be provided by multiple modules simultaneously. An example would be OAuth backends for various providers (Google, Facebook, Git, ...).
  • $name Service name.
  • $description Brief description of the service.
  • $module_name_prefix A mandatory module name prefix can be defined so that the module for this service is always placed in a specific group of modules – and thus effectively in a specific directory.
public static create(
ReflectionClass $class,
array $attributes
) : static
Internal method – creates a definition instance for the given class.
public getGroup(
) : string
Returns the string identifier of the service group to which the service belongs.
public setGroup(
string $group
) : void
Sets the string identifier of the service group to which the service belongs.
public setInterfaceClassName(
string $interface_class_name
) : void
Sets the name of the interface or abstract class describing the service interface.
public getInterfaceClassName(
) : string
Returns the name of the interface or abstract class describing the service interface.
public getModuleNamePrefix(
) : string
Returns the optional mandatory prefix of the application module name.
public setModuleNamePrefix(
string $module_name_prefix
) : void
Sets the optional mandatory prefix of the application module name.
public isMandatory(
) : bool
Indicates whether the service is mandatory and must have a provider module in the application.
public setIsMandatory(
bool $is_mandatory
) : void
Sets whether the service is mandatory and must have a provider module in the application.
public isMultipleMode(
) : bool
Indicates whether multiple providers can exist for the given service in the application.
public setMultipleMode(
bool $multiple_mode
) : void
Sets whether multiple providers can exist for the given service in the application.
public setName(
string $name
) : void
Sets the name of the service.
public getName(
) : string
Returns the name of the service.
public setDescription(
string $description
) : void
Sets a brief description of the service.
public getDescription(
) : string
Returns a brief description of the service.
Previous chapter
Jet\Application_Service_List
Next chapter
User interface generation