Simple (syntax) Highlight - Line numbering

<?php
/**
* Copyright (c) 2007, Laurent Laville <pear@laurent-laville.org>
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the authors nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category Web_Services
* @package Services_W3C_CSSValidator
* @author Laurent Laville <pear@laurent-laville.org>
* @license http://www.opensource.org/licenses/bsd-license.php BSD
* @version CVS: $id$
* @link http://pear.php.net/package/Services_W3C_CSSValidator
* @since File available since Release 0.1.0
*/
require_once 'HTTP/Request.php';
require_once 'Services/W3C/CSSValidator/Response.php';
require_once 'Services/W3C/CSSValidator/Error.php';
require_once 'Services/W3C/CSSValidator/Warning.php';
/**
* Base class for utilizing the W3C CSS Validator service.
*
* @category Web_Services
* @package Services_W3C_CSSValidator
* @author Laurent Laville <pear@laurent-laville.org>
* @license http://www.opensource.org/licenses/bsd-license.php BSD
* @link http://pear.php.net/package/Services_W3C_CSSValidator
* @since Class available since Release 0.1.0
*/
class Services_W3C_CSSValidator
{
/**
* URI to the W3C validator.
*
* @var string
* @since 0.1.0
* @access public
*/
public $validator_uri = 'http://jigsaw.w3.org/css-validator/validator';
/**
* The URL of the document to validate
*
* @var string
* @since 0.1.0
* @access public
*/
public $uri;
/**
* Internally used filename of a file to upload to the validator
* POSTed as multipart/form-data
*
* @var string
* @since 0.1.0
* @access public
*/
public $uploaded_file;
/**
* CSS fragment to validate.
*
* Full documents only. At the moment, will only work if data is sent with the
* UTF-8 encoding.
*
* @var string
* @since 0.1.0
* @access public
*/
public $fragment;
/**
* Output format
*
* Triggers the various outputs formats of the validator. If unset, the usual
* Web html format will be sent. If set to soap12, the SOAP1.2 interface will be
* triggered. See below for the SOAP 1.2 response format description.
*
* @var string
* @since 0.1.0
* @access public
*/
public $output = 'soap12';
/**
* Warning level
*
* Default value is '1', and value could one of these :
* <ul>
* <li>2</li> all warning messages
* <li>1</li> normal report
* <li>0</li> most important warning messages
* <li>no</li> none messages
* </ul>
*
* @var string
* @since 0.1.0
* @access public
*/
public $warning;
/**
* Profile
*
* Default value is 'css21', and value could one of these :
* <ul>
* <li>none</li> none profile
* <li>css1</li> CSS level 1
* <li>css2</li> CSS level 2
* <li>css21</li> CSS level 2.1
* <li>css3</li> CSS level 3
* <li>svg</li> SVG
* <li>svgbasic</li> SVG Basic
* <li>svgtiny</li> SVG Tiny
* <li>mobile</li> Mobile
* <li>atsc-tv</li> ATSC TV
* <li>tv</li> TV
* </ul>
*
* @var string
* @since 0.1.0
* @access public
*/
public $profile = 'css21';
/**
* User medium
*
* Default value is 'all', and value could one of these :
* <ul>
* <li>all</li>
* <li>aural</li>
* <li>braille</li>
* <li>embossed</li>
* <li>handheld</li>
* <li>print</li>
* <li>projection</li>
* <li>screen</li>
* <li>tty</li>
* <li>tv</li>
* <li>presentation</li>
* </ul>
*
* @var string
* @since 0.1.0
* @access public
*/
public $usermedium = 'all';
/**
* Language used for response messages
*
* Default value is 'en', and value could one of these :
* en, fr, ja, es, zh-cn, nl, de
*
* @var string
* @since 0.1.0
* @access public
*/
public $lang = 'en';
/**
* HTTP_Request object.
*
* @var object
* @since 0.1.0
* @access protected
*/
protected $request;
/**
* Constructor for the class.
*
* @param array $options An array of options
* @since 0.1.0
* @access public
*/
public function __construct($options = array())
{
$this->setOptions($options);
}
/**
* Sets options for the class.
* Pass an associative array of options for the class.
*
* @param array $options An array of options
* @return void
* @since 0.1.0
* @access public
*/
public function setOptions($options)
{
foreach ($options as $option=>$val) {
$this->$option = $val;
}
}
/**
* Validates a given URI
*
* Executes the validator using the current parameters and returns a Response
* object on success.
*
* @param string $uri The address to the page to validate ex: http://example.com/
* @return mixed object Services_W3C_CSSValidator_Response
* if web service call successfull,
* boolean FALSE otherwise
* @since 0.1.0
* @access public
*/
public function validateUri($uri)
{
$this->uri = $uri;
$this->buildRequest('uri');
if ($this->sendRequest()) {
return Services_W3C_CSSValidator::parseSOAP12Response(
$this->request->getResponseBody());
} else {
return false;
}
}
/**
* Validates the local file
*
* Requests validation on the local file, from an instance of the W3C validator.
* The file is posted to the W3C validator using multipart/form-data.
*
* @param string $file file to be validated.
* @return mixed object Services_W3C_CSSValidator_Response
* if web service call successfull,
* boolean FALSE otherwise
* @since 0.1.0
* @access public
*/
public function validateFile($file)
{
if (file_exists($file)) {
$this->uploaded_file = $file;
$this->buildRequest('file'); //return $this->request;
if ($this->sendRequest()) {
return Services_W3C_CSSValidator::parseSOAP12Response(
$this->request->getResponseBody());
} else {
return false;
}
} else {
return false;
}
}
/**
* Validate an html string
*
* @param string $html Full html document fragment
* @return mixed object Services_W3C_CSSValidator_Response
* if web service call successfull,
* boolean FALSE otherwise
* @since 0.1.0
* @access public
*/
public function validateFragment($css)
{
$this->fragment = $css;
$this->buildRequest('fragment');
if ($this->sendRequest()) {
return Services_W3C_CSSValidator::parseSOAP12Response(
$this->request->getResponseBody());
} else {
return false;
}
}
/**
* Prepares a request object to send to the validator.
*
* @param string $type uri, file, or fragment
* @return void
* @since 0.1.0
* @access protected
*/
protected function buildRequest($type = 'uri')
{
$this->request = new HTTP_Request();
$this->request->setURL($this->validator_uri);
switch ($type) {
case 'uri':
default:
$this->request->setMethod(HTTP_REQUEST_METHOD_GET);
$this->request->addQueryString('uri', $this->uri);
$method = 'addQueryString';
break;
case 'file':
$this->request->setMethod(HTTP_REQUEST_METHOD_POST);
$this->request->addFile('file',
$this->uploaded_file,
'text/css');
$method = 'addPostData';
break;
case 'fragment':
$this->request->setMethod(HTTP_REQUEST_METHOD_GET);
$this->request->addQueryString('text', $this->fragment);
$method = 'addQueryString';
break;
}
$options = array('output', 'warning', 'profile', 'usermedium', 'lang');
foreach ($options as $option) {
if (isset($this->$option)) {
if (is_bool($this->$option)) {
$this->request->$method($option, intval($this->$option));
} else {
$this->request->$method($option, $this->$option);
}
}
}
}
/**
* Actually sends the request to the CSS Validator service
*
* @return bool TRUE if request was sent successfully, FALSE otherwise
* @since 0.1.0
* @access protected
*/
protected function sendRequest()
{
if (PEAR::isError($this->request->sendRequest())) {
return false;
} else {
return true;
}
}
/**
* Parse an XML response from the validator
*
* This function parses a SOAP 1.2 response xml string from the validator.
*
* @param string $xml The raw soap12 XML response from the validator.
* @return mixed object Services_W3C_CSSValidator_Response
* if parsing soap12 response successfully,
* boolean FALSE otherwise
* @since 0.1.0
* @access protected
*/
protected static function parseSOAP12Response($xml)
{
$doc = new DOMDocument();
// try to load soap 1.2 xml response, and suppress warning reports if any
if (@$doc->loadXML($xml)) {
$response = new Services_W3C_CSSValidator_Response();
// Get the standard CDATA elements
$cdata = array('uri', 'checkedby', 'csslevel', 'date');
foreach ($cdata as $var) {
$element = $doc->getElementsByTagName($var);
if ($element->length) {
$response->$var = $element->item(0)->nodeValue;
}
}
// Handle the bool element validity
$element = $doc->getElementsByTagName('validity');
if ($element->length &&
$element->item(0)->nodeValue == 'true') {
$response->validity = true;
} else {
$response->validity = false;
}
if (!$response->validity) {
$errors = $doc->getElementsByTagName('error');
foreach ($errors as $error) {
$response->errors[] =
new Services_W3C_CSSValidator_Error($error);
}
}
$warnings = $doc->getElementsByTagName('warning');
foreach ($warnings as $warning) {
$response->warnings[] =
new Services_W3C_CSSValidator_Warning($warning);
}
return $response;
} else {
// Could not load the XML document
return false;
}
}
}
?>