Overview

Namespaces

  • Nethgui
    • Adapter
    • Authorization
    • Component
    • Controller
      • Collection
      • Table
    • Exception
    • Log
    • Model
    • Module
      • Help
      • Notification
    • Renderer
    • Serializer
    • System
    • Test
      • Tool
      • Unit
        • Nethgui
          • Adapter
            • ParameterSet
          • Authorization
          • Log
          • Module
            • Notification
          • Renderer
          • Serializer
          • System
          • Utility
          • View
        • Test
          • Tool
    • Utility
    • View
    • Widget
      • Xhtml
  • None
  • Test
    • Tool

Classes

  • Nethgui\Adapter\ArrayAdapter
  • Nethgui\Adapter\LazyLoaderAdapter
  • Nethgui\Adapter\MultipleAdapter
  • Nethgui\Adapter\RecordAdapter
  • Nethgui\Adapter\RecordKeyAdapter
  • Nethgui\Adapter\ScalarAdapter
  • Nethgui\Adapter\TableAdapter
  • Nethgui\Adapter\TabularValueAdapter
  • Nethgui\Authorization\AuthorizedModuleSet
  • Nethgui\Authorization\JsonPolicyDecisionPoint
  • Nethgui\Authorization\LazyAccessControlResponse
  • Nethgui\Authorization\PolicyRule
  • Nethgui\Authorization\User
  • Nethgui\Controller\AbstractController
  • Nethgui\Controller\Collection\AbstractAction
  • Nethgui\Controller\CollectionController
  • Nethgui\Controller\CompositeController
  • Nethgui\Controller\ListComposite
  • Nethgui\Controller\NullRequest
  • Nethgui\Controller\RequestTest
  • Nethgui\Controller\Table\AbstractAction
  • Nethgui\Controller\Table\Help
  • Nethgui\Controller\Table\Modify
  • Nethgui\Controller\Table\PluggableAction
  • Nethgui\Controller\Table\PluginCollector
  • Nethgui\Controller\Table\Read
  • Nethgui\Controller\Table\RowAbstractAction
  • Nethgui\Controller\Table\RowPluginAction
  • Nethgui\Controller\TableController
  • Nethgui\Controller\TabsController
  • Nethgui\Framework
  • Nethgui\Log\AbstractLog
  • Nethgui\Log\Nullog
  • Nethgui\Log\Syslog
  • Nethgui\Model\StaticFiles
  • Nethgui\Model\SystemTasks
  • Nethgui\Model\UserNotifications
  • Nethgui\Model\ValidationErrors
  • Nethgui\Module\AbstractModule
  • Nethgui\Module\Composite
  • Nethgui\Module\CompositeModuleAttributesProvider
  • Nethgui\Module\Help
  • Nethgui\Module\Help\Common
  • Nethgui\Module\Help\Read
  • Nethgui\Module\Help\Renderer
  • Nethgui\Module\Help\Show
  • Nethgui\Module\Help\Template
  • Nethgui\Module\Help\Widget
  • Nethgui\Module\Language
  • Nethgui\Module\Login
  • Nethgui\Module\Logout
  • Nethgui\Module\Main
  • Nethgui\Module\Menu
  • Nethgui\Module\ModuleLoader
  • Nethgui\Module\Notification
  • Nethgui\Module\Notification\AbstractNotification
  • Nethgui\Module\Resource
  • Nethgui\Module\SimpleModuleAttributesProvider
  • Nethgui\Module\SystemModuleAttributesProvider
  • Nethgui\Module\Tracker
  • Nethgui\Renderer\AbstractRenderer
  • Nethgui\Renderer\Json
  • Nethgui\Renderer\ReadonlyView
  • Nethgui\Renderer\TemplateRenderer
  • Nethgui\Renderer\Xhtml
  • Nethgui\Serializer\ArrayAccessSerializer
  • Nethgui\Serializer\KeySerializer
  • Nethgui\Serializer\PropSerializer
  • Nethgui\System\AlwaysFailValidator
  • Nethgui\System\CallbackValidator
  • Nethgui\System\NethPlatform
  • Nethgui\System\Process
  • Nethgui\System\SessionDatabase
  • Nethgui\System\Validator
  • Nethgui\Test\Tool\DB
  • Nethgui\Test\Tool\MockFactory
  • Nethgui\Test\Tool\MockObject
  • Nethgui\Test\Tool\MockState
  • Nethgui\Test\Tool\PermissivePolicyDecisionPoint
  • Nethgui\Test\Tool\StaticPolicyDecisionPoint
  • Nethgui\Test\Unit\Nethgui\Adapter\ArrayAdapterTest
  • Nethgui\Test\Unit\Nethgui\Adapter\MultipleAdapterTest
  • Nethgui\Test\Unit\Nethgui\Adapter\ParameterSet\EmptyTest
  • Nethgui\Test\Unit\Nethgui\Adapter\ParameterSet\WithAdaptersTest
  • Nethgui\Test\Unit\Nethgui\Adapter\RecordAdapterTest
  • Nethgui\Test\Unit\Nethgui\Adapter\RecordAdapterTester
  • Nethgui\Test\Unit\Nethgui\Adapter\RecordKeyAdapterTest
  • Nethgui\Test\Unit\Nethgui\Adapter\ScalarAdapterTest
  • Nethgui\Test\Unit\Nethgui\Adapter\TableAdapter1Test
  • Nethgui\Test\Unit\Nethgui\Adapter\TableAdapter2Test
  • Nethgui\Test\Unit\Nethgui\Adapter\TabularValueAdapterDegradedTest
  • Nethgui\Test\Unit\Nethgui\Adapter\TabularValueAdapterTest
  • Nethgui\Test\Unit\Nethgui\Authorization\JsonPolicyDecisionPointTest
  • Nethgui\Test\Unit\Nethgui\Authorization\LazyAccessControlResponseTest
  • Nethgui\Test\Unit\Nethgui\Authorization\PolicyRuleTest
  • Nethgui\Test\Unit\Nethgui\Authorization\ResourceX
  • Nethgui\Test\Unit\Nethgui\Authorization\ResourceY
  • Nethgui\Test\Unit\Nethgui\Authorization\UserTest
  • Nethgui\Test\Unit\Nethgui\Log\AbstractLogTest
  • Nethgui\Test\Unit\Nethgui\Log\NullogTest
  • Nethgui\Test\Unit\Nethgui\Log\SyslogTest
  • Nethgui\Test\Unit\Nethgui\Module\AbstractControllerTest
  • Nethgui\Test\Unit\Nethgui\Module\CompositeTest
  • Nethgui\Test\Unit\Nethgui\Module\ConcreteCompositeModule1
  • Nethgui\Test\Unit\Nethgui\Module\ConcreteStandardModule1
  • Nethgui\Test\Unit\Nethgui\Module\ModuleLoaderTest
  • Nethgui\Test\Unit\Nethgui\Module\Notification\TextNotificationBoxTest
  • Nethgui\Test\Unit\Nethgui\Module\SimpleModuleAttributesProviderTest
  • Nethgui\Test\Unit\Nethgui\Renderer\HttpCommandReceiverTest
  • Nethgui\Test\Unit\Nethgui\Renderer\JsonTest
  • Nethgui\Test\Unit\Nethgui\Renderer\MarshallingReceiverTest
  • Nethgui\Test\Unit\Nethgui\Renderer\XhtmlTest
  • Nethgui\Test\Unit\Nethgui\Serializer\ArrayAccessSerializerTest
  • Nethgui\Test\Unit\Nethgui\Serializer\KeySerializerTest
  • Nethgui\Test\Unit\Nethgui\Serializer\PropSerializerTest
  • Nethgui\Test\Unit\Nethgui\System\EsmithDatabaseTest
  • Nethgui\Test\Unit\Nethgui\System\NethPlatformTest
  • Nethgui\Test\Unit\Nethgui\System\PhpWrapperExec
  • Nethgui\Test\Unit\Nethgui\System\SessionDatabaseTest
  • Nethgui\Test\Unit\Nethgui\System\TestSession
  • Nethgui\Test\Unit\Nethgui\System\ValidatorTest
  • Nethgui\Test\Unit\Nethgui\Utility\PamAuthenticatorTest
  • Nethgui\Test\Unit\Nethgui\View\CommandTest
  • Nethgui\Test\Unit\Nethgui\View\TranslatorTest
  • Nethgui\Test\Unit\Nethgui\View\TranslatorTestModule
  • Nethgui\Test\Unit\Nethgui\View\TranslatorTestPhpWrapper
  • Nethgui\Test\Unit\Nethgui\View\ViewCommandSequenceTest
  • Nethgui\Test\Unit\Nethgui\View\ViewGenericTest
  • Nethgui\Test\Unit\Test\Tool\MockStateTest
  • Nethgui\Utility\ArrayDisposable
  • Nethgui\Utility\HttpResponse
  • Nethgui\Utility\NullSession
  • Nethgui\Utility\PhpWrapper
  • Nethgui\View\LegacyCommandBag
  • Nethgui\View\Translator
  • Nethgui\View\View
  • Nethgui\Widget\AbstractWidget
  • Nethgui\Widget\Xhtml\Button
  • Nethgui\Widget\Xhtml\CheckBox
  • Nethgui\Widget\Xhtml\CollectionEditor
  • Nethgui\Widget\Xhtml\Columns
  • Nethgui\Widget\Xhtml\ElementList
  • Nethgui\Widget\Xhtml\ElementModule
  • Nethgui\Widget\Xhtml\ElementRenderer
  • Nethgui\Widget\Xhtml\Fieldset
  • Nethgui\Widget\Xhtml\FieldsetSwitch
  • Nethgui\Widget\Xhtml\FileUpload
  • Nethgui\Widget\Xhtml\Form
  • Nethgui\Widget\Xhtml\Hidden
  • Nethgui\Widget\Xhtml\ObjectPicker
  • Nethgui\Widget\Xhtml\ObjectsCollection
  • Nethgui\Widget\Xhtml\Panel
  • Nethgui\Widget\Xhtml\ProgressBar
  • Nethgui\Widget\Xhtml\RadioButton
  • Nethgui\Widget\Xhtml\Selector
  • Nethgui\Widget\Xhtml\Slider
  • Nethgui\Widget\Xhtml\Tabs
  • Nethgui\Widget\Xhtml\TextArea
  • Nethgui\Widget\Xhtml\TextInput
  • Nethgui\Widget\Xhtml\TextLabel
  • Nethgui\Widget\Xhtml\TextList
  • Nethgui\Widget\XhtmlWidget

Interfaces

  • Nethgui\Adapter\AdapterAggregateInterface
  • Nethgui\Adapter\AdapterAggregationInterface
  • Nethgui\Adapter\AdapterInterface
  • Nethgui\Adapter\ModifiableInterface
  • Nethgui\Authorization\AccessControlResponseInterface
  • Nethgui\Authorization\AuthorizationAttributesProviderInterface
  • Nethgui\Authorization\PolicyDecisionPointInterface
  • Nethgui\Authorization\PolicyEnforcementPointInterface
  • Nethgui\Authorization\UserInterface
  • Nethgui\Component\DependencyConsumer
  • Nethgui\Component\DependencyInjectorAggregate
  • Nethgui\Controller\Collection\ActionInterface
  • Nethgui\Controller\RequestHandlerInterface
  • Nethgui\Controller\RequestInterface
  • Nethgui\Controller\ValidationReportInterface
  • Nethgui\Log\LogConsumerInterface
  • Nethgui\Log\LogInterface
  • Nethgui\Module\ModuleAttributesInterface
  • Nethgui\Module\ModuleCompositeInterface
  • Nethgui\Module\ModuleInterface
  • Nethgui\Module\ModuleSetInterface
  • Nethgui\Renderer\WidgetFactoryInterface
  • Nethgui\Renderer\WidgetInterface
  • Nethgui\System\DatabaseInterface
  • Nethgui\System\MandatoryValidatorInterface
  • Nethgui\System\PlatformConsumerInterface
  • Nethgui\System\PlatformInterface
  • Nethgui\System\ProcessInterface
  • Nethgui\System\ValidatorInterface
  • Nethgui\Utility\DisposableInterface
  • Nethgui\Utility\PhpConsumerInterface
  • Nethgui\Utility\SessionConsumerInterface
  • Nethgui\Utility\SessionInterface
  • Nethgui\View\CommandReceiverInterface
  • Nethgui\View\TranslatorInterface
  • Nethgui\View\ViewableInterface
  • Nethgui\View\ViewInterface

Exceptions

  • Nethgui\Exception\AuthorizationException
  • Nethgui\Exception\HttpException

Functions

  • Nethgui\array_end
  • Nethgui\array_head
  • Nethgui\array_rest
  • Overview
  • Namespace
  • Class
  • Deprecated
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 
<?php
namespace Nethgui\Adapter;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer 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 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer 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 NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * A Multiple adapter maps a scalar value to multiple keys or props through
 * a "reader" and a "writer" callback function.
 * 
 * The reader function is mandatory, the writer is optional. If you set to NULL the writer
 * callback you get a read-only adapter, but save() still records the modified state.
 * 
 * NOTE: If the adapter has an empty set of serializers the reader function will
 * still be called with no arguments.
 * 
 * @api
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 */
class MultipleAdapter implements AdapterInterface
{
    private $innerAdapters = array();
    private $readerCallback;
    private $writerCallback;
    private $modified;

    /**
     * @see \Nethgui\Serializer\SerializerInterface
     * @param callback $readerCallback The reader PHP callback function: (p1, ..., pN) -> V
     * @param callback $writerCallback The writer PHP callback function: V -> (p1, ..., pN)
     * @param array $serializers An array of \Nethgui\Serializer\SerializerInterface objects
     */
    public function __construct($readerCallback, $writerCallback = NULL, $serializers = array())
    {
        if ( ! is_callable($readerCallback)) {
            throw new \InvalidArgumentException(sprintf('%s: Must provide a Reader callback function', get_class($this)), 1322149372);
        }

        $this->readerCallback = $readerCallback;
        $this->writerCallback = $writerCallback;

        foreach ($serializers as $serializer) {
            if ( ! $serializer instanceof \Nethgui\Serializer\SerializerInterface) {
                throw new \InvalidArgumentException(sprintf('%s: Invalid serializer instance. A serializer must implement \Nethgui\Serializer\SerializerInterface.', get_class($this)), 1322149373);
            }

            $this->innerAdapters[] = new ScalarAdapter($serializer);
        }
    }

    public function get()
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        return $this->value;
    }

    public function set($value)
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if ($this->value !== $value) {
            $this->value = $value;
            $this->modified = TRUE;
        }
    }

    public function delete()
    {
        $this->set(NULL);
    }

    public function isModified()
    {
        return $this->modified === TRUE;
    }

    public function save()
    {
        if ( ! $this->isModified()) {
            return FALSE;
        }

        $saved = FALSE;

        if (is_callable($this->writerCallback)) {
            $values = call_user_func($this->writerCallback, $this->value);
            $index = 0;
            if (is_array($values)) {
                foreach ($values as $value) {
                    $this->innerAdapters[$index]->set($value);
                    $saved = $this->innerAdapters[$index]->save() ? TRUE : $saved;
                    $index ++;
                }
            } elseif ($values === TRUE) {
                $saved = TRUE;
            }
        } else {
            $saved = TRUE;
        }

        $this->modified = FALSE;

        return $saved;
    }

    private function lazyInitialization()
    {
        $values = array();
        foreach ($this->innerAdapters as $innerAdapter) {
            $values[] = $innerAdapter->get();
        }

        $this->value = call_user_func_array($this->readerCallback, $values);
        $this->modified = FALSE;
    }

}
Nethgui Framework API documentation generated by ApiGen