class.OutputStrategy.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.OutputStrategy.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/core/class.WCMFException.php");

/**
 * @interface OutputStrategy
 * @ingroup Output
 * @brief OutputStrategy is used to write an object's content
 * to a destination (called 'document') using a special format.
 * OutputStrategy implements the 'Strategy Pattern'.
 * The abstract base class OutputStrategy defines the interface for all
 * specialized OutputStrategy classes.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class OutputStrategy
{
  /**
   * Write the document header.
   * Subclasses of OutputStrategy override this method to implement the specialized
   * format.
   */
  function writeHeader()
  { 
    WCMFException::throwEx("writeHeader() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * Write the document footer.
   * Subclasses of OutputStrategy override this method to implement the specialized
   * format.
   */
  function writeFooter()
  { 
    WCMFException::throwEx("writeFooter() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * Write the object's content.
   * @param obj The object to write.
   * Subclasses of OutputStrategy override this method to implement the specialized
   * format.
   */
  function writeObject(&$obj)
  { 
    WCMFException::throwEx("writeObject() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
}
?>