0.10/balance/modules/puny/classes/parsers/Puny_Parser.class.php

<?php
/*
 * 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.
 */

/**
 * Puny_Parser
 * 
 * Base class for Puny parser implementations. 
 * 
 * @abstract
 * 
 * @author ahart
 */
abstract class Puny_Parser {
	
	/**
	 * Implementations of this function should return the 
	 * final (display-ready) version of the provided content.
	 * 
	 * @param string $content The content to parse
	 * @returns string
	 * @abstract
	 */
	public abstract function parse( $content );
	
}