class RulesLoop

class RulesLoop extends RulesActionContainer {
    
    /**
     * @var string
     */
    protected $itemName = 'loop';
    protected $listItemInfo;
    public function __construct($settings = array(), $variables = NULL) {
        $this->setUp();
        $this->settings = (array) $settings + array(
            'item:var' => 'list_item',
            'item:label' => t('Current list item'),
        );
        if (!empty($variables)) {
            $this->info['variables'] = $variables;
        }
    }
    public function pluginParameterInfo() {
        $info['list'] = array(
            'type' => 'list',
            'restriction' => 'selector',
            'label' => t('List'),
            'description' => t('The list to loop over. The loop will step through each item in the list, allowing further actions on them. See <a href="@url"> the online handbook</a> for more information on how to use loops.', array(
                '@url' => rules_external_help('loops'),
            )),
        );
        return $info;
    }
    public function integrityCheck() {
        parent::integrityCheck();
        $this->checkVarName($this->settings['item:var']);
    }
    public function listItemInfo() {
        if (!isset($this->listItemInfo)) {
            if ($info = $this->getArgumentInfo('list')) {
                // Pass through the variable info keys like property info.
                $this->listItemInfo = array_intersect_key($info, array_flip(array(
                    'type',
                    'property info',
                    'bundle',
                )));
                $this->listItemInfo['type'] = isset($info['type']) ? entity_property_list_extract_type($info['type']) : 'unknown';
            }
            else {
                $this->listItemInfo = array(
                    'type' => 'unknown',
                );
            }
            $this->listItemInfo['label'] = $this->settings['item:label'];
        }
        return $this->listItemInfo;
    }
    public function evaluate(RulesState $state) {
        try {
            $param_info = $this->pluginParameterInfo();
            $list = $this->getArgument('list', $param_info['list'], $state);
            $item_var_info = $this->listItemInfo();
            $item_var_name = $this->settings['item:var'];
            if (isset($this->settings['list:select'])) {
                rules_log('Looping over the list items of %selector', array(
                    '%selector' => $this->settings['list:select'],
                ), RulesLog::INFO, $this);
            }
            // Loop over the list and evaluate the children for each list item.
            foreach ($list as $key => $item) {
                // Use a separate state so variables are available in the loop only.
                $state2 = clone $state;
                $state2->addVariable($item_var_name, $list[$key], $item_var_info);
                parent::evaluate($state2);
                // Update variables from parent scope.
                foreach ($state->variables as $var_key => &$var_value) {
                    if (array_key_exists($var_key, $state2->variables)) {
                        $var_value = $state2->variables[$var_key];
                    }
                }
            }
        } catch (RulesEvaluationException $e) {
            rules_log($e->msg, $e->args, $e->severity);
            rules_log('Unable to evaluate %name.', array(
                '%name' => $this->getPluginName(),
            ), RulesLog::WARN, $this);
        }
    }
    protected function stateVariables($element = NULL) {
        return array(
            $this->settings['item:var'] => $this->listItemInfo(),
        ) + parent::stateVariables($element);
    }
    public function label() {
        return !empty($this->label) ? $this->label : t('Loop');
    }
    protected function exportChildren($key = 'DO') {
        return parent::exportChildren($key);
    }
    protected function importChildren($export, $key = 'DO') {
        parent::importChildren($export, $key);
    }
    protected function exportSettings() {
        $export = parent::exportSettings();
        $export['ITEM'][$this->settings['item:var']] = $this->settings['item:label'];
        return $export;
    }
    protected function importSettings($export) {
        parent::importSettings($export);
        if (isset($export['ITEM'])) {
            $this->settings['item:var'] = rules_array_key($export['ITEM']);
            $this->settings['item:label'] = reset($export['ITEM']);
        }
    }

}