YAWK\WIDGETS\TWITCH\EMBED\twitch Class Reference

Embed any Twitch channel. More...

Inheritance diagram for YAWK\WIDGETS\TWITCH\EMBED\twitch:

Public Member Functions
	__construct ($db)
	Load all widget settings from database and fill object. More...
	init ()
	Init twitch widget. More...
Public Member Functions inherited from YAWK\widget
	getHeading ($heading, $subtext)
	Get widget heading and subtext, return headline. More...
	getWidgetSettingsArray ($db)
	Get widget settings and return it as array. More...
	printObject ()
	Print all object data. More...

Public Attributes
	$twitchChannel = "yourChannel"
	$twitchChannelFullscreen = true
	$twitchChannelHeight = "720"
	$twitchChannelWidth = "100%"
	$twitchChat = "1"
	$twitchChatHeight = "250"
	$twitchChatWidth = "100%"
	$twitchHeading = ''
	$twitchSubtext = ''
	$widget = ''
Public Attributes inherited from YAWK\widget
	$data
	$date_publish
	$date_unpublish
	$folder
	$id
	$marginBottom
	$marginTop
	$name
	$pageID
	$position
	$published
	$sort
	$widgetTitle
	$widgetType

Additional Inherited Members
Static Public Member Functions inherited from YAWK\widget
static	getAllSettingsIntoArray ($db, $widgetID)
	Returns an array with all widget settings data. More...
static	getAllWidgetTypes ($db)
	Return all widget types as associative array. More...
static	getCurrentWidgetPath ($db)
	return current widget path More...
static	getFacebookLikeBox ()
	return the facebook likebox widget More...
static	getLoginBox ()
	return the user login box widget More...
static	loadWidgetsOfPage ($db, $page)
	Returns an array of all widgets that are linked with given page->id. More...

Detailed Description

Embed any Twitch channel.

Twitch Widget - embed any twitch channel

Twitch is a gaming streaming platform. Use this widget to embed any twitch channel. You can set your channel, width, height, either if the chat should be displayed or not, allow fullscreen and more.

Author

Daniel Retzl danie.nosp@m.lret.nosp@m.zl@gm.nosp@m.ail..nosp@m.com

Copyright

2018 Daniel Retzl

Version

1.0.0

Definition at line 16 of file twitch.php.

Constructor & Destructor Documentation

__construct()

YAWK\WIDGETS\TWITCH\EMBED\twitch::__construct

(

$db

)

Load all widget settings from database and fill object.

Parameters

object

$db

Database Object

Load all widget settings on object init.

Definition at line 44 of file twitch.php.

        {
            // load this widget settings from db
            $this->widget = new \YAWK\widget();
            $settings = $this->widget->getWidgetSettingsArray($db);
            foreach ($settings as $property => $value) {
                $this->$property = $value;
            }

References $db, $settings, $value, and YAWK\widget\getWidgetSettingsArray().

Member Function Documentation

init()

YAWK\WIDGETS\TWITCH\EMBED\twitch::init

(

)

Init twitch widget.

Twitch Widget Init

Definition at line 58 of file twitch.php.

        {   // display heading
            echo $this->getHeading($this->twitchHeading, $this->twitchSubtext);
            // to output correct html
            if ($this->twitchChannelFullscreen === "true") {   // set fullscreen property
                $allowfullscreen = "allowfullscreen=\"true\"";
            } else {   // or leave empty if fullscreen should be false
                $allowfullscreen = '';
            }
// HTML output
            echo "
<!-- twitch video stream -->
<iframe
    src=\"http://player.twitch.tv/?channel=$this->twitchChannel\"
    height=\"$this->twitchChannelHeight\"
    width=\"$this->twitchChannelWidth\"
    frameborder=\"0\"
    scrolling=\"no\"
    $allowfullscreen\">
</iframe>";
 
// check if chat should be shown
            if (isset($this->twitchChat) && ($this->twitchChat === 1)) {   // ok, show chat html frame
                echo "
 
<!-- twitch chat -->
<iframe 
    frameborder=\"0\"
    scrolling=\"no\"
    src=\"http://www.twitch.tv/popout/$this->twitchChannel/chat\"
    height=\"$this->twitchChatHeight\"
    width=\"$this->twitchChatWidth\">
</iframe>";
            }

References YAWK\widget\getHeading().

Member Data Documentation

$twitchChannel

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChannel = "yourChannel"

Parameters

string

Channel that will be included

Definition at line 25 of file twitch.php.

$twitchChannelFullscreen

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChannelFullscreen = true

Parameters

bool	Allow fullscreen?

Definition at line 31 of file twitch.php.

$twitchChannelHeight

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChannelHeight = "720"

Parameters

string

Height of your channel

Definition at line 27 of file twitch.php.

$twitchChannelWidth

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChannelWidth = "100%"

Parameters

string

Width of your channel

Definition at line 29 of file twitch.php.

$twitchChat

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChat = "1"

Parameters

int	Show chat window?

Definition at line 33 of file twitch.php.

$twitchChatHeight

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChatHeight = "250"

Parameters

int	Chat window height

Definition at line 35 of file twitch.php.

$twitchChatWidth

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchChatWidth = "100%"

Parameters

int	Chat window width

Definition at line 37 of file twitch.php.

$twitchHeading

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchHeading = ''

Parameters

string

Title that will be shown above widget

Definition at line 21 of file twitch.php.

$twitchSubtext

YAWK\WIDGETS\TWITCH\EMBED\twitch::$twitchSubtext = ''

Parameters

string

Subtext will be displayed beside title

Definition at line 23 of file twitch.php.

$widget

YAWK\WIDGETS\TWITCH\EMBED\twitch::$widget = ''

Parameters

object

global widget object data

Definition at line 19 of file twitch.php.

---

The documentation for this class was generated from the following file:

• /var/www/htdocs/yawk.io/system/widgets/twitch/classes/twitch.php