Overview

Namespaces

  • Pharborist
    • Constants
    • ControlStructures
    • Exceptions
    • Functions
    • Generators
    • Namespaces
    • Objects
    • Operators
    • Types
    • Variables

Classes

  • ArrayLookupNode
  • BacktickNode
  • BlankStatementNode
  • CommaListNode
  • CommentNode
  • DocCommentNode
  • EchoStatementNode
  • EchoTagStatementNode
  • ExpressionStatementNode
  • Filter
  • Formatter
  • FormatterFactory
  • LineCommentBlockNode
  • Node
  • NodeCollection
  • OperatorFactory
  • ParenthesisNode
  • ParentNode
  • Parser
  • PartialCommentNode
  • PartialNode
  • RootNode
  • SourceDiscovery
  • SourcePosition
  • SplatNode
  • StatementBlockNode
  • StatementNode
  • TemplateNode
  • Token
  • TokenIterator
  • Tokenizer
  • TokenNode
  • UnsetStatementNode
  • VisitorBase
  • WhitespaceNode

Interfaces

  • ExpressionNode
  • NodeInterface
  • ParentNodeInterface
  • ParserException
  • VisitorInterface

Traits

  • DocCommentTrait
  • ParenTrait
  • UncommentTrait
  • Overview
  • Namespace
  • Class

Class LineCommentBlockNode

A block of line comments, e.g.:

// This is a haiku.
// Seriously, it is one.
// Isn't that awesome?
Pharborist\Node implements Pharborist\NodeInterface
Extended by Pharborist\ParentNode implements Pharborist\ParentNodeInterface
Extended by Pharborist\LineCommentBlockNode uses Pharborist\UncommentTrait
Namespace: Pharborist
Located at LineCommentBlockNode.php
Methods summary
public static Pharborist\LineCommentBlockNode
# create( string $comment )

Create line comment block.

Create line comment block.

Parameters

$comment
Comment without leading prefix.

Returns

Pharborist\LineCommentBlockNode
public string
# getCommentText( )

Returns

string
public
# setIndent( string $indent )

Set indent for document comment.

Set indent for document comment.

Parameters

$indent
Whitespace to use as indent.

Returns


$this
public
# removeIndent( )

Remove indent from document comment.

Remove indent from document comment.

Returns


$this
public
# addIndent( string $whitespace )

Add indent to comment.

Add indent to comment.

Parameters

$whitespace
Additional whitespace to add.

Returns


$this
Methods inherited from Pharborist\ParentNode
__clone(), __toString(), acceptVisitor(), addChild(), addChildren(), append(), childCount(), children(), clear(), find(), firstChild(), firstToken(), getSourcePosition(), getText(), getTree(), has(), isDescendant(), isEmpty(), lastChild(), lastToken(), mergeNode(), prepend(), walk()
Methods inherited from Pharborist\Node
after(), appendTo(), before(), closest(), fromValue(), furthest(), getLogicalBlock(), getRoot(), getStatement(), hasRoot(), index(), insertAfter(), insertBefore(), is(), isAllOf(), isAnyOf(), next(), nextAll(), nextToken(), nextUntil(), parent(), parents(), parentsUntil(), prependTo(), previous(), previousAll(), previousToken(), previousUntil(), remove(), replaceAll(), replaceWith(), siblings(), sortKey(), swapWith()
Methods used from Pharborist\UncommentTrait
uncomment()
Pharborist API documentation generated by ApiGen