Documentation

Comment
in package

Pop CSS comment class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
2.0.0

Table of Contents

Properties

$comment  : string|null
Comment string
$trailingNewLine  : bool
Trailing new line
$wrap  : int
Comment wrap

Methods

__construct()  : mixed
Constructor
__toString()  : string
To string method
getComment()  : string|null
Get comment
getWrap()  : int
Get wrap
hasTrailingNewLine()  : bool
Has trailing new line
render()  : string
Method to render the selector CSS
setComment()  : Comment
Set comment
setTrailingNewLine()  : Comment
Set trailing new line
setWrap()  : Comment
Set wrap

Properties

$comment

Comment string

protected string|null $comment = null

$trailingNewLine

Trailing new line

protected bool $trailingNewLine = true

$wrap

Comment wrap

protected int $wrap = 80

Methods

__construct()

Constructor

public __construct(string $comment[, int $wrap = 80 ][, bool $trailingNewLine = false ]) : mixed

Instantiate the CSS comment object

Parameters
$comment : string
$wrap : int = 80
$trailingNewLine : bool = false

__toString()

To string method

public __toString() : string
Return values
string

getComment()

Get comment

public getComment() : string|null
Return values
string|null

getWrap()

Get wrap

public getWrap() : int
Return values
int

hasTrailingNewLine()

Has trailing new line

public hasTrailingNewLine() : bool
Return values
bool

render()

Method to render the selector CSS

public render() : string
Return values
string

setComment()

Set comment

public setComment(string $comment) : Comment
Parameters
$comment : string
Return values
Comment

setTrailingNewLine()

Set trailing new line

public setTrailingNewLine(bool $trailingNewLine) : Comment
Parameters
$trailingNewLine : bool
Return values
Comment

        
On this page

Search results