• Home
  • WPDKUIProgress

PHP Class WPDKUIProgress

Since: 1.7.1
Author: =undo= ([email protected])
Inheritance: extends WPDKHTMLTag
Show file Open project: wpxtreme/wpdk

Public Properties

Property Type Description
$bars array List of WPDKUIProgressBar instances.
$id string Progress (container) id.
$width string Width (px or %) of progress container.

Public Methods

Method Description
__construct ( string $id, integer | array | WPDKUIProgressBar $percentage_or_bars, string $progress_bar_type = WPDKUIProgressBarType::BASIC ) : WPDKUIProgress Create an instance of WPDKUIProgress class.
html ( ) : string Return the HTML markup of Progress
init ( string $id, integer | array | WPDKUIProgressBar $percentage_or_bars, string $progress_bar_type = WPDKUIProgressBarType::BASIC ) : WPDKUIProgress Return an instance of WPDKUIProgress class

Method Details

__construct() public method

Create an instance of WPDKUIProgress class.
public __construct ( string $id, integer | array | WPDKUIProgressBar $percentage_or_bars, string $progress_bar_type = WPDKUIProgressBarType::BASIC ) : WPDKUIProgress
$id string ID attribute for main container.
$percentage_or_bars integer | array | WPDKUIProgressBar Optional. Numeric percentage, array of WPDKUIProgressBar or an instance of WPDKUIProgressBar.
$progress_bar_type string Optional. Type of progress. This params is ignored if `$percentage_or_bars` is ans array of WPDKUIProgressBar
return WPDKUIProgress

html() public method

Return the HTML markup of Progress
public html ( ) : string
return string

init() public static method

Return an instance of WPDKUIProgress class
public static init ( string $id, integer | array | WPDKUIProgressBar $percentage_or_bars, string $progress_bar_type = WPDKUIProgressBarType::BASIC ) : WPDKUIProgress
$id string ID attribute for main container.
$percentage_or_bars integer | array | WPDKUIProgressBar Optional. Numeric percentage, array of WPDKUIProgressBar or an instance of WPDKUIProgressBar.
$progress_bar_type string Optional. Type of progress. This params is ignored if `$percentage_or_bars` is ans array of WPDKUIProgressBar
return WPDKUIProgress

Property Details

$bars public property

List of WPDKUIProgressBar instances.
public array $bars
return array

$id public property

Progress (container) id.
public string $id
return string

$width public property

Width (px or %) of progress container.
public string $width
return string