Force a field to be mandatory on condition

Prerequisite: You must be familiar with the Syntax used in Tutorials and have already created an extension.

This use case is just one way of forcing a field to be provided.

In this use case, we want to ensure that

1. At creation, no location is proposed
2. On modification of a Server in production, the location becomes mandatory.

itop_design / classes

    <class id="PhysicalDevice">
      <fields>
        <field id="location_id">
          <!-- force location_id flags to be recomputed if status is changed -->
          <dependencies _delta="redefine">
            <attribute id="org_id"/>
            <attribute id="status"/>
          </dependencies>
        </field>
      </fields>
    </class>
    <class id="Server" _delta="must_exist">
      <event_listeners>
        <event_listener id="evtSetInitialFlags" _delta="define">
          <!-- Id of the event does not have to be the same as the function, but why not -->
          <event>EVENT_DB_SET_INITIAL_ATTRIBUTES_FLAGS</event>
          <rank>10</rank>
          <!-- The callback must be the name of an existing class method. The name is free -->
          <callback>evtSetInitialFlags</callback>
        </event_listener>
        <event_listener id="evtSetAttributeFlags" _delta="define">
          <event>EVENT_DB_SET_ATTRIBUTES_FLAGS</event>
          <rank>10</rank>
          <callback>evtSetAttributeFlags</callback>
        </event_listener>
      </event_listeners>
      <methods>
        <method id="evtSetInitialFlags" _delta="define">
          <static>false</static>
          <access>public </access>
          <comment>This method is called once, before opening the Server creation form</comment>
          <code><![CDATA[

public function evtSetInitialAttributeFlags(Combodo\iTop\Service\Events\EventData $oEventData)
{   // Force the flags, ignoring existing ones    
    $this->ForceInitialAttributeFlags('location_id', OPT_ATT_HIDDEN); 
    // $this->AddInitialAttributeFlags('location_id', OPT_ATT_HIDDEN); might not do the work if some other code forces it to be mandatory as well
}

          ]]></ code>
        </method>
        <method id="evtSetAttributeFlags" _delta="define">
          <static>false</static>
          <access>public </access>
          <comment>This method is called once, before opening a Server modification form</comment>
          <code><![CDATA[

public function evtSetAttributeFlags(Combodo\iTop\Service\Events\EventData $oEventData)
{              
   if ((MetaModel::IsValidAttCode(get_class($this), 'status')) && ($this->Get('status') == 'production'))
   {  // Adding the mandatory flag
      $this->AddAttributeFlags('location_id', OPT_ATT_MANDATORY);
      // You can decide that you want to set this flag and ignore what other flags already set for this attribute
      // In which case instead of AddAttri... use ForceAttri...
      $this->ForceAttributeFlags('location_id', OPT_ATT_MANDATORY);
   }
}

          ]]></ code>
        </method>
      </methods>
    </class>

Declare the above events and methods twice, one on each class Server and NetworkDevice

Declare the above events and methods on class DatacenterDevice instead of Server

We can also check on submission that a location was provided, if not, we prevent the creation/modification and display an error message so the user can fill the Location and submit again.

Similar Tutorials

• Force a field to be mandatory on condition
• Force a field to be mandatory on condition
• Check To Write Event
• Check data integrity
• Check To Write Event