// Jericho HTML Parser - Java based library for analysing and manipulating HTML
// Version 3.2
// Copyright (C) 2004-2009 Martin Jericho
// http://jericho.htmlparser.net/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of either one of the following licences:
//
// 1. The Eclipse Public License (EPL) version 1.0,
// included in this distribution in the file licence-epl-1.0.html
// or available at http://www.eclipse.org/legal/epl-v10.html
//
// 2. The GNU Lesser General Public License (LGPL) version 2.1 or later,
// included in this distribution in the file licence-lgpl-2.1.txt
// or available at http://www.gnu.org/licenses/lgpl.txt
//
// This library is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the individual licence texts for more details.
package net.htmlparser.jericho;
/**
* Contains {@linkplain TagType tag types} related to the <a target="_blank" href="http://www.php.net">PHP</a> server platform.
* <p>
* There is no specific tag type defined for the
* <a target="_blank" href="http://www.php.net/manual/en/ini.core.php#ini.asp-tags">ASP-style PHP tag</a>
* as it is recognised using the {@linkplain StartTagType#SERVER_COMMON common server tag type}.
* <p>
* The tag types defined in this class are not {@linkplain TagType#register() registered} by default.
* The {@link #register()} method is provided as a convenient way to register them all at once.
*/
public final class PHPTagTypes {
/**
* The tag type given to a
* <a target="_blank" href="http://www.php.net/manual/en/language.basic-syntax.php#language.basic-syntax.phpmode">standard PHP tag</a>
* (<code><?php<var> ... </var>?></code>).
* <p>
* Note that the standard PHP processor includes as part of the tag any newline characters directly following the
* {@linkplain TagType#getClosingDelimiter() closing delimiter}, but PHP tags recognised by this library do not include
* trailing newlines. They must be removed manually if required.
* <p>
* This library only correctly recognises standard PHP tags that comply with the XML syntax for processing instructions.
* Specifically, the tag is terminated by the first occurrence of the {@linkplain TagType#getClosingDelimiter() closing delimiter}
* "<code>?></code>", even if it occurs within a PHP string expression.
* Unfortunately there is no reliable way to determine the end of a PHP tag without the use of a PHP parser.
* The following code is an example of a standard PHP tag that is <b>not</b> recognised correctly by this parser
* because of the presence of the closing delimiter within a string expression:
* <p>
* <pre><?php echo("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"); ?></pre>
* <p>
* This is recognised as the PHP tag: <code><?php echo("<?xml version=\"1.0\" encoding=\"UTF-8\"?></code><br />
* followed by the plain text: <code>\n"); ?></code>
* <p>
* <dl>
* <dt>Properties:</dt>
* <dd>
* <table class="bordered" style="margin: 15px" cellspacing="0">
* <tr><th>Property<th>Value
* <tr><td>{@link StartTagType#getDescription() Description}<td>PHP standard tag
* <tr><td>{@link StartTagType#getStartDelimiter() StartDelimiter}<td><code><?php</code>
* <tr><td>{@link StartTagType#getClosingDelimiter() ClosingDelimiter}<td><code>?></code>
* <tr><td>{@link StartTagType#isServerTag() IsServerTag}<td><code>true</code>
* <tr><td>{@link StartTagType#getNamePrefix() NamePrefix}<td><code>?php</code>
* <tr><td>{@link StartTagType#getCorrespondingEndTagType() CorrespondingEndTagType}<td><code>null</code>
* <tr><td>{@link StartTagType#hasAttributes() HasAttributes}<td><code>false</code>
* <tr><td>{@link StartTagType#isNameAfterPrefixRequired() IsNameAfterPrefixRequired}<td><code>false</code>
* </table>
* <dt>Example:</dt>
* <dd><code><?php echo '<p>Hello World</p>'; ?></code></dd>
* </dl>
*/
public static final StartTagType PHP_STANDARD=StartTagTypePHPStandard.INSTANCE;
/**
* The tag type given to a
* <a target="_blank" href="http://www.php.net/manual/en/ini.core.php#ini.short-open-tag">short-form PHP tag</a>
* (<code><?<var> ... </var>?></code>).
* <p>
* When this tag type is {@linkplain TagType#register() registered}, all
* {@linkplain StartTagType#XML_PROCESSING_INSTRUCTION XML processing instructions} are recognised as short-form PHP tags instead.
* <p>
* The comments in the documentation of the {@link #PHP_STANDARD} tag type regarding the termination of PHP tags and
* trailing newlines are also applicable to this tag type.
* <p>
* <dl>
* <dt>Properties:</dt>
* <dd>
* <table class="bordered" style="margin: 15px" cellspacing="0">
* <tr><th>Property<th>Value
* <tr><td>{@link StartTagType#getDescription() Description}<td>PHP short tag
* <tr><td>{@link StartTagType#getStartDelimiter() StartDelimiter}<td><code><?</code>
* <tr><td>{@link StartTagType#getClosingDelimiter() ClosingDelimiter}<td><code>?></code>
* <tr><td>{@link StartTagType#isServerTag() IsServerTag}<td><code>true</code>
* <tr><td>{@link StartTagType#getNamePrefix() NamePrefix}<td><code>?</code>
* <tr><td>{@link StartTagType#getCorrespondingEndTagType() CorrespondingEndTagType}<td><code>null</code>
* <tr><td>{@link StartTagType#hasAttributes() HasAttributes}<td><code>false</code>
* <tr><td>{@link StartTagType#isNameAfterPrefixRequired() IsNameAfterPrefixRequired}<td><code>false</code>
* </table>
* <dt>Example:</dt>
* <dd><code><? echo '<p>Hello World</p>'; ?></code></dd>
* </dl>
*/
public static final StartTagType PHP_SHORT=StartTagTypePHPShort.INSTANCE;
/**
* The tag type given to a
* <a target="_blank" href="http://www.php.net/manual/en/language.basic-syntax.php#language.basic-syntax.phpmode">script-style PHP start tag</a>
* (<code><script language="php"><var> ... </var></script></code>).
* <p>
* <dl>
* <dt>Properties:</dt>
* <dd>
* <table class="bordered" style="margin: 15px" cellspacing="0">
* <tr><th>Property<th>Value
* <tr><td>{@link StartTagType#getDescription() Description}<td>PHP script
* <tr><td>{@link StartTagType#getStartDelimiter() StartDelimiter}<td><code><script</code>
* <tr><td>{@link StartTagType#getClosingDelimiter() ClosingDelimiter}<td><code>></code>
* <tr><td>{@link StartTagType#isServerTag() IsServerTag}<td><code>true</code>
* <tr><td>{@link StartTagType#getNamePrefix() NamePrefix}<td><code>script</code>
* <tr><td>{@link StartTagType#getCorrespondingEndTagType() CorrespondingEndTagType}<td>{@link EndTagType#NORMAL}
* <tr><td>{@link StartTagType#hasAttributes() HasAttributes}<td><code>true</code>
* <tr><td>{@link StartTagType#isNameAfterPrefixRequired() IsNameAfterPrefixRequired}<td><code>false</code>
* </table>
* <dt>Example:</dt>
* <dd><code><script language="php"> echo '<p>Hello World</p>'; </script></code></dd>
* </dl>
*/
public static final StartTagType PHP_SCRIPT=StartTagTypePHPScript.INSTANCE;
private static final TagType[] TAG_TYPES={
PHP_STANDARD,
PHP_SHORT,
PHP_SCRIPT
};
private PHPTagTypes() {}
/**
* {@linkplain TagType#register() Registers} all of the tag types defined in this class at once.
* <p>
* The tag types must be registered before the parser will recognise them.
*/
public static void register() {
for (TagType tagType : TAG_TYPES) tagType.register();
}
/**
* {@linkplain TagType#deregister() Deregisters} all of the tag types defined in this class at once.
*/
public static void deregister() {
for (TagType tagType : TAG_TYPES) tagType.deregister();
}
/**
* Indicates whether the specified tag type is defined in this class.
*
* @param tagType the {@link TagType} to test.
* @return <code>true</code> if the specified tag type is defined in this class, otherwise <code>false</code>.
*/
public static boolean defines(final TagType tagType) {
for (TagType definedTagType : TAG_TYPES) if (tagType==definedTagType) return true;
return false;
}
/**
* Indicates whether the specified tag type is recognised by a <a target="_blank" href="http://www.php.net">PHP</a> parser.
* <p>
* This is true if the specified tag type is {@linkplain #defines(TagType) defined in this class} or if it is the
* {@linkplain StartTagType#SERVER_COMMON common server tag type}.
*
* @param tagType the {@link TagType} to test.
* @return <code>true</code> if the specified tag type is recognised by a <a target="_blank" href="http://www.php.net">PHP</a> parser, otherwise <code>false</code>.
*/
public static boolean isParsedByPHP(final TagType tagType) {
return tagType==StartTagType.SERVER_COMMON || defines(tagType);
}
}