Dec 21
Docs For Class RecordWarning

phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:
В пакете:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
Parser
parserDescParser
phpDocumentorTParser
phpDocumentor_HighlightParser
phpDocumentor_HighlightWordParser
phpDocumentor_peardoc2_XML_Beautifier
phpDocumentor_TutorialHighlightParser
phpDocumentor_XML_Beautifier_Tokenizer
ppageParser
XMLPackagePageParser

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

DescHTML
parserB
parserBr
parserCode
parserDescVar
parserI
parserKbd
parserList
parserPre
parserSamp

DocBlockTags
parserAccessTag
parserExampleTag
parserFileSourceTag
parserLicenseTag
parserLinkTag
parserMethodTag
parserNameTag
parserParamTag
parserPropertyReadTag
parserPropertyTag
parserPropertyWriteTag
parserReturnTag
parserSeeTag
parserStaticvarTag
parserTag
parserTutorialTag
parserUsedByTag
parserUsesTag
parserVarTag

Errors
ErrorTracker
RecordError
RecordWarning

InlineTags
parserExampleInlineTag
parserIdInlineTag
parserInheritdocInlineTag
parserInlineTag
parserLinkInlineTag
parserSourceInlineTag
parserTocInlineTag
parserTutorialInlineTag

Links
abstractLink
classLink
constLink
defineLink
functionLink
globalLink
methodLink
pageLink
tutorialLink
varLink

Tutorial
parserCData
parserEntity
parserXMLDocBookTag

ParserData
parserBase
parserData
parserPage
parserStringWithInlineTags

WordParsers
ObjectWordParser
phpDocumentorTWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
parserClass
parserConst
parserDefine
parserElement
parserFunction
parserGlobal
parserInclude
parserMethod
parserPackagePage
parserTutorial
parserVar

Class: RecordWarning

Source Location: /phpDocumentor/Errors.inc

Class Overview

encapsulates warning information

Author(s):

Greg Beaver <cellog@php.net>

Version:

Release: @VER@

Copyright:

2001-2008 Gregory Beaver

Variables

Methods

Child classes:

RecordError: encapsulates error information

Class Details

[line 746]
encapsulates warning information

Tags:

author:	Greg Beaver <cellog@php.net>
version:	Release: @VER@
copyright:	2001-2008 Gregory Beaver
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
todo:	CS cleanup - change package to PhpDocumentor
license:	LGPL

[ Top ]

Class Variables

$data =

[line 767]

error string

Type:

string

[ Top ]

$file = false

[line 757]

file this error occurred in

Type:

string

[ Top ]

$linenum =

[line 762]

line number of the file this error occurred in

Type:

integer

[ Top ]

$num =

[line 773]

error number

Tags:

see:

Type:

string

[ Top ]

$type = 'phpDocumentor_warning_descrip'

[line 752]

name of global variable that descriptors for this warning/error is kept

Type:

string

[ Top ]

Class Methods

constructor RecordWarning [line 785]

RecordWarning RecordWarning(
string
$file, integer
$linenum, integer
$num, string
$data...)

Constructor

Tags:

todo:

CS Cleanup - do I need to add $data to the method signature? to sprintf based on the error number

Parameters:

string	$file	filename this error occurred in ($file)
integer	$linenum	line number this error occurred on ($linenum)
integer	$num	Error number defined in Errors.inc
string	$data...	variable number of strings, up to 4,

[ Top ]

method output [line 809]

void output(
[string
$string = false])

prints the warning

Overridden in child classes as:

RecordError::output(): prints the error

Parameters:

string

$string

the warning to print

[ Top ]

Поддержать сайт на родительском проекте КГБ