Login   Register  
PHP Classes
elePHPant
Icontem

File: core/interfaces/ITags.intf.php

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Marius Zadara  >  PAX  >  core/interfaces/ITags.intf.php  >  Download  
File: core/interfaces/ITags.intf.php
Role: Class source
Content type: text/plain
Description: Tags interface
Class: PAX
Interpret XML command scripts with PHP classes
Author: By
Last change: version update
Date: 5 years ago
Size: 1,690 bytes
 

Contents

Class file image Download
<?php

/**
 * Page DocBlock definition
 * @package org.zadara.marius.pax
 */

/**
 * General interface for a tag object.
 * 
 * @author Marius Zadara <marius@zadara.org>
 * @category Interfaces
 * @copyright (C) 2008-2009 Marius Zadara
 * @license Free for non-comercial use
 * @package org.zadara.marius.pax
 * @see IPAXObject
 */
interface ITags extends IPAXObject  
{
    
/**
     * Method to check if a tag is allowed.
     *
     * @param string $rootTag The root tag from the definition file
     * @param string $tag The searched tag
     * @return boolean
     */
    
public function isAllowedTag($rootTag$tag);
    
    
/**
     * Method to filter the tags according to the definition file.
     * Throws exception if error encountered
     *
     * @access public
     * @static 
     * @param config $config The PAX config object
     * @param config $elements The PAX elements object
     * @param config $directories The PAX directories object
     * @param config $filenames The PAX filenames object
     * @param array $nodes The array with the current nodes 
     * @param array $namespaces The array with the current namespaces
     * @param string $paxNsSeparator The separator used in tag namespace definition
     * @return void
     */
    
public static function filterTags(&$config, &$elements$directories$filenames, &$nodes, &$namespaces$paxNsSeparator);
    
    
    
    
/**
     * Method to filter the tag content.
     * Throws exception in case of error.
     *
     * @param config $config The PAX config object
     * @param config $elements The PAX elements object
     * @param array $nodes The PAX nodes array
     */
    
public static function filterTagContent(&$config$elements, &$nodes);    

}

?>