<?php
/**
 * File containing ezcDocumentDocbookToOdtIgnoreHandler class.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package Document
 * @version //autogen//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @access private
 */

/**
 * Handler for elements, which are safe to be ignored.
 *
 * This ignore handler can either ignore only a single XML element level or can 
 * be configured to ignore a complete XML sub-tree.
 *
 * @package Document
 * @version //autogen//
 * @access private
 */
class ezcDocumentDocbookToOdtIgnoreHandler extends ezcDocumentDocbookToOdtBaseHandler
{
    /**
     * If child elements should also be ignored. 
     * 
     * @var bool
     */
    protected $deepIgnore;

    /**
     * Creates a new ignore handler.
     *
     * If $deepIgnore is set to true, child elements of the ignored element 
     * will also not be visited. 
     * 
     * @param ezcDocumentOdtStyler $styler
     * @param bool $deepIgnore 
     */
    public function __construct( ezcDocumentOdtStyler $styler, $deepIgnore = false )
    {
        parent::__construct( $styler );
        $this->deepIgnore = $deepIgnore;
    }

    /**
     * Handle a node
     *
     * Handle / transform a given node, and return the result of the
     * conversion.
     *
     * @param ezcDocumentElementVisitorConverter $converter
     * @param DOMElement $node
     * @param mixed $root
     * @return mixed
     */
    public function handle( ezcDocumentElementVisitorConverter $converter, DOMElement $node, $root )
    {
        if ( !$this->deepIgnore )
        {
            return $converter->visitChildren( $node, $root );
        }
        return $root;
    }
}

?>
