Document/src/document/xml/odt/filter/style/rule/list_level.php

<?php
/**
 * File containing the ezcDocumentOdtListLevelStyleFilterRule 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//
 * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved.
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @access private
 */

/**
 * Style filter rule to distinguish list types.
 *
 * ODT does not distinguish between numbered and itemized lists on an XML 
 * element level, but through styling information. This rule implements 
 * detection of numbered lists.
 *
 * @package Document
 * @version //autogen//
 * @access private
 * @todo More information about the list can be extracted from the style, like 
 *       the start value and continuation of previous lists.
 */
class ezcDocumentOdtListLevelStyleFilterRule implements ezcDocumentOdtStyleFilterRule
{
    /**
     * Returns if the given $odtElement is handled by the rule.
     * 
     * @param DOMElement $odtElement 
     * @return bool
     */
    public function handles( DOMElement $odtElement )
    {
        return ( $odtElement->localName === 'list' );
    }

    /**
     * Detects numbered lists from ODT style information.
     *
     * This method detects the type of list in $odtElement by its list-level 
     * style and sets the attributes for $odtElement accordingly to have it 
     * converted properly to DocBook.
     * 
     * @param DOMElement $odtElement 
     * @param ezcDocumentOdtStyleInferencer $styleInferencer
     */
    public function filter( DOMElement $odtElement, ezcDocumentOdtStyleInferencer $styleInferencer )
    {
        $listStyle = $styleInferencer->getListStyle( $odtElement );
        
        $currentLevel = $this->getListLevel( $odtElement );
        
        switch ( get_class( $listStyle->listLevels[$currentLevel] ) )
        {
            case 'ezcDocumentOdtListLevelStyleNumber':
                $this->setNumberListProperties( $odtElement, $listStyle->listLevels[$currentLevel] );
                break;
            case 'ezcDocumentOdtListLevelStyleBullet':
                $this->setItemListProperties( $odtElement, $listStyle->listLevels[$currentLevel] );
                break;
        }
    }

    /**
     * Sets properties of numbered lists based on $listLevelProps.
     * 
     * @param DOMElement $numList 
     * @param ezcDocumentOdtListLevelStyleNumber $listLevelProps 
     * @return void
     */
    protected function setNumberListProperties( DOMElement $numList, ezcDocumentOdtListLevelStyleNumber $listLevelProps )
    {
        $numList->setProperty(
            'type',
            'orderedlist'
        );
    }

    /**
     * Sets properties of itemized lists based on $listLevelProps.
     * 
     * @param DOMElement $itemList 
     * @param ezcDocumentOdtListLevelStyleBullet $listLevelProps 
     */
    protected function setItemListProperties( DOMElement $itemList, ezcDocumentOdtListLevelStyleBullet $listLevelProps )
    {
        $itemList->setProperty(
            'type',
            'itemizedlist'
        );
    }

    /**
     * Determines the list level of $odtElement.
     *
     * Note that leveling starts with 1!
     * 
     * @param DOMElement $odtElement 
     * @return int
     */
    protected function getListLevel( DOMElement $odtElement )
    {
        if ( $odtElement->parentNode->nodeType === XML_DOCUMENT_NODE )
        {
            return 1;
        }
        return $this->getListLevel( $odtElement->parentNode )
            + ( $odtElement->parentNode->localName === 'list' ? 1 : 0 );
    }
}

?>