<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2007 Fabian Hickert
  Copyright (C) 2011-2016  FusionDirectory

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/

class setupStep extends simplePlugin
{
  protected $s_short_name   = 'Still undefined';
  protected $s_title        = 'Still undefined';
  protected $s_description  = 'Still undefined';

  var $is_active    = FALSE;
  var $is_enabled   = FALSE;
  var $is_completed = FALSE;

  var $header_image = '';

  static function getAttributesInfo (): array
  {
    return [];
  }

  function __construct ($parent)
  {
    parent::__construct(NULL, NULL, $parent);
    $this->update_strings();
  }

  public function __serialize(): array
  {
    return [
      's_short_name'   => $this->s_short_name,
      's_title'        => $this->s_title,
      's_description'  => $this->s_description,
      'is_active'      => $this->is_active,
      'is_enabled'     => $this->is_enabled,
      'is_completed'   => $this->is_completed,
      'header_image'   => $this->header_image,
    ];
  }

  public function __unserialize(array $data): void
  {
    $this->s_short_name   = $data['s_short_name'] ?? 'Still undefined';
    $this->s_title        = $data['s_title'] ?? 'Still undefined';
    $this->s_description  = $data['s_description'] ?? 'Still undefined';
    $this->is_active      = $data['is_active'] ?? FALSE;
    $this->is_enabled     = $data['is_enabled'] ?? FALSE;
    $this->is_completed   = $data['is_completed'] ?? FALSE;
    $this->header_image   = $data['header_image'] ?? '';
  }

  function update_strings ()
  {
    die('abstract method');
  }

  function get_short_name ()
  {
    return $this->s_short_name;
  }

  function get_title ()
  {
    return $this->s_title;
  }

  function get_description ()
  {
    return $this->s_description;
  }

  function is_active ()
  {
    return $this->is_active;
  }

  function is_enabled ()
  {
    return $this->is_enabled;
  }

  function is_completed ()
  {
    return $this->is_completed;
  }

  function set_active ($value = TRUE)
  {
    $this->is_active = (bool) $value;
  }

  function set_enabled ($value = TRUE)
  {
    $this->is_enabled = (bool) $value;
  }

  function set_completed ($value = TRUE)
  {
    $this->is_completed = (bool) $value;
  }

  /* Return attributes handled by this setup step */
  public function get_attributes (): array
  {
    $tmp = [];
    foreach (array_keys($this->attributesAccess) as $attr) {
      $tmp[$attr] = $this->$attr;
    }
    return $tmp;
  }

  /* bypass LDAP loading */
  protected function loadAttributes ()
  {
    foreach ($this->attributesInfo as $sectionInfo) {
      foreach ($sectionInfo['attrs'] as $attr) {
        $attr->setParent($this);
      }
    }
  }
}