Page tree
Skip to end of metadata
Go to start of metadata


1. Abstrakte Methoden

1.1. get_actions

Syntax:

array get_actions()

Beschreibung:

Muss ein assoziatives Array zurückgeben. Der Schlüssel ist vom Datentyp String, welcher die ID der im Wert gespeicherten Aktion identifiziert. Als Wert kann entweder eine einzelne Aktion oder eine Liste von Aktionen abgelegt werden. Diese Liste ist ein gewöhnliches Array.

Beispiel:

function get_actions()
{
  return array(
          'mySave' => addon_util_action::get_ajax_action('ajax/mySave', array('{widget1}', '{widget2}')),
          'myReset' => addon_util_action::get_ajax_action('ajax/myReset'),
     );
}


1.2. get_assignments

Syntax:

array get_assignments()

Beschreibung:

Mit dieser Methode werden diverse Variablen für den Template-Parser bereitgestellt. Sie muss ein assoziatives Array zurückgeben, in dem der Schlüssel die im Template nutzbaren IDs darstellt. Der Typ des jeweiligen Wertes hängt von dem Widget-Typ oder der Nutzung durch den Parser ab.

Beispiel:

function get_assignments()
{
  return array(
         'textID' => 'Das ist ein Text.',
         'auswahlboxID' => array(
              array('id' => '1', 'value' => '0', 'label' => 'Punkt 1', 'selected' => true),
              array('id' => '2', 'value' => '1', 'label' => 'Punkt 2'                    ),
         ),
         'ifBedingung' => function($scope, $assignments)
         {
              return $scope['myForKey'] == 3;
         }
     );
}

1.3. get_template

Syntax:

string get_template()

Beschreibung:

Muss den Pfad zu einem Template zurückgeben, das für die View genutzt werden soll.

Beispiel:

function get_template()
{
  return "templates/view.xml";
}

1.4. save

Syntax:

addon_response save()

Beschreibung:

Diese Methode wird aufgerufen, wenn die Formular-Daten gespeichert werden. Die Formulardaten befinden sich in Klasseneigenschaft $form_data.

Beispiel:

function save()
{
  $a = $this->form_data['field_a'];
  return new addon_response(true); 
}

2. Interne Methoden

2.1. in_edit

Syntax:

boolean in_edit()

Beschreibung:

Diese Methode liefert true, wenn sich das Formular im Bearbeitungsmodus befindet. Dies wird benötigt, um das Formular dazu passend schreibbar oder schreibgeschützt darzustellen.

Beispiel:

public function get_assignments()
{
       
        $edit   = $this->in_edit();
        
        return array(
            'edit' => $edit,
        );
        
}

2.2. save_error

Syntax:

boolean save_error()

Beschreibung:

Die Methode liefert true, wenn beim Speichern des Objektes ein Fehler auftrat.

Beispiel:

public function get_assignments()
{
       
        $error_occurred   = $this->save_error();
        
        if ($this->save_error()) {
            
            $form_data = $this->form_data;
            
            return array(
                'test_a' => $form_data['test_a'],
            );
        }

        return array(
            'test_a' => '',
        );
        
}

3. Optionale Methoden

3.1. get_on_load_actions

Syntax:

array get_on_load_actions()

Beschreibung:

Liefert eine als eindimensionales Array definierte Sequenz der nach vollständigem Laden auszuführenden util_actions zurück. Die Aktionen werden zuvor in get_actions() definiert.

Beispiel:

    public function get_on_load_actions()
    {
        return array(
            'simpleOnLoadAction',
            // ... more actions
        );
    }

4. Vererbte Methoden

  • No labels