id int32 0 241k | repo stringlengths 6 63 | path stringlengths 5 140 | func_name stringlengths 3 151 | original_string stringlengths 84 13k | language stringclasses 1 value | code stringlengths 84 13k | code_tokens list | docstring stringlengths 3 47.2k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 91 247 |
|---|---|---|---|---|---|---|---|---|---|---|---|
45,200 | xibosignage/oauth2-xibo-cms | src/Entity/XiboTicker.php | XiboTicker.create | public function create($sourceId, $uri, $dataSetId, $duration, $useDuration, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->sourceId = $sourceId;
$this->uri = $uri;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->dataSetId = $dataSetId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Ticker widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/ticker/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($sourceId, $uri, $dataSetId, $duration, $useDuration, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->sourceId = $sourceId;
$this->uri = $uri;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->dataSetId = $dataSetId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Ticker widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/ticker/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"sourceId",
",",
"$",
"uri",
",",
"$",
"dataSetId",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"playlistId",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"("... | Create new Ticker widget.
@param int $sourceId The Ticker source ID, 1 for rss feed, 2 for dataset
@param string $uri The Feed URI, For sourceId=1, the link for the rss feed
@param int $duration The Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $dataSetId The DataSet ID for sourceId=2
@param int $playlistId The playlist ID
@return XiboTicker | [
"Create",
"new",
"Ticker",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboTicker.php#L161-L174 |
45,201 | xibosignage/oauth2-xibo-cms | src/Entity/XiboTicker.php | XiboTicker.editFeed | public function editFeed($name, $duration, $useDuration, $updateInterval, $effect, $speed, $copyright = '', $numItems, $takeItemsFrom, $durationIsPerItem, $itemsSideBySide, $itemsPerPage, $dateFormat, $allowedAttributes, $stripTags, $backgroundColor, $disableDateSort, $textDirection, $noDataMessage, $templateId, $overrideTemplate, $template, $css = '', $javaScript = '', $randomiseItems, $widgetId)
{
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->updateInterval = $updateInterval;
$this->effect = $effect;
$this->speed = $speed;
$this->copyright = $copyright;
$this->numItems = $numItems;
$this->takeItemsFrom = $takeItemsFrom;
$this->durationIsPerItem = $durationIsPerItem;
$this->itemsSideBySide = $itemsSideBySide;
$this->itemsPerPage = $itemsPerPage;
$this->dateFormat = $dateFormat;
$this->allowedAttributes = $allowedAttributes;
$this->stripTags = $stripTags;
$this->backgroundColor = $backgroundColor;
$this->disableDateSort = $disableDateSort;
$this->textDirection = $textDirection;
$this->noDataMessage = $noDataMessage;
$this->templateId = $templateId;
$this->overrideTemplate = $overrideTemplate;
$this->template = $template;
$this->css = $css;
$this->javaScript = $javaScript;
$this->randomiseItems = $randomiseItems;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function editFeed($name, $duration, $useDuration, $updateInterval, $effect, $speed, $copyright = '', $numItems, $takeItemsFrom, $durationIsPerItem, $itemsSideBySide, $itemsPerPage, $dateFormat, $allowedAttributes, $stripTags, $backgroundColor, $disableDateSort, $textDirection, $noDataMessage, $templateId, $overrideTemplate, $template, $css = '', $javaScript = '', $randomiseItems, $widgetId)
{
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->updateInterval = $updateInterval;
$this->effect = $effect;
$this->speed = $speed;
$this->copyright = $copyright;
$this->numItems = $numItems;
$this->takeItemsFrom = $takeItemsFrom;
$this->durationIsPerItem = $durationIsPerItem;
$this->itemsSideBySide = $itemsSideBySide;
$this->itemsPerPage = $itemsPerPage;
$this->dateFormat = $dateFormat;
$this->allowedAttributes = $allowedAttributes;
$this->stripTags = $stripTags;
$this->backgroundColor = $backgroundColor;
$this->disableDateSort = $disableDateSort;
$this->textDirection = $textDirection;
$this->noDataMessage = $noDataMessage;
$this->templateId = $templateId;
$this->overrideTemplate = $overrideTemplate;
$this->template = $template;
$this->css = $css;
$this->javaScript = $javaScript;
$this->randomiseItems = $randomiseItems;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"editFeed",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"updateInterval",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"copyright",
"=",
"''",
",",
"$",
"numItems",
",",
"$",
"takeItemsFrom",
","... | Edit Ticker with RSS FEED source.
@param string $name Optional Widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $updateInterval Update interval in minutes
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)
@param string $copyright Copyright information to display as the last item in this feed. can be styled with the #copyright CSS selector
@param int $numItems The number of RSS items you want to display
@param string $takeItemsFrom Take the items form the beginning or the end of the list, available options: start, end
@param int $durationIsPerItem Flag The duration specified is per item, otherwise it is per feed
@param int $itemsSideBySide Should items be shown side by side
@param int $itemsPerPage When in single mode, how many items per page should be shown
@param string $dateFormat The date format to apply to all dates returned by the ticker
@param string $allowedAttributes A comma separated list of attributes that should not be stripped from the feed
@param string $stripTags A comma separated list of attributes that should be stripped from the feed
@param string $backgroundColor A HEX color to use as the background color of this widget
@param int $disableDateSort Flag Should the date sort applied to the feed be disabled?
@param string $textDirection Which direction does the text in the feed use? Available options: ltr, rtl
@param string $noDataMessage A message to display when no data is returned from the source
@param string $templateId Template you’d like to apply, options available: title-only, prominent-title-with-desc-and-name-separator, media-rss-with-title, media-rss-wth-left-hand-text, media-rss-image-only
@param int $overrideTemplate override template checkbox
@param string $template Template for each item, replaces [itemsTemplate] in main template
@param string $css Optional StyleSheet CSS
@param string $javaScript Optional CSS
@param int $randomiseItems Flag whether to randomise the feed
@param int $widgetId The Widget ID
@return XiboTicker | [
"Edit",
"Ticker",
"with",
"RSS",
"FEED",
"source",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboTicker.php#L207-L240 |
45,202 | xibosignage/oauth2-xibo-cms | src/Entity/XiboTicker.php | XiboTicker.editDataSet | public function editDataSet($name, $duration, $useDuration, $updateInterval, $effect, $speed, $durationIsPerItem, $itemsSideBySide, $itemsPerPage, $upperLimit, $lowerLimit, $dateFormat, $backgroundColor, $noDataMessage, $template, $css = '', $filter, $ordering, $useOrderingClause, $useFilteringClause, $widgetId)
{
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->updateInterval = $updateInterval;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->itemsSideBySide = $itemsSideBySide;
$this->itemsPerPage = $itemsPerPage;
$this->upperLimit = $upperLimit;
$this->lowerLimit = $lowerLimit;
$this->dateFormat = $dateFormat;
$this->backgroundColor = $backgroundColor;
$this->noDataMessage = $noDataMessage;
$this->template = $template;
$this->css = $css;
$this->filter = $filter;
$this->ordering = $ordering;
$this->useOrderingClause = $useOrderingClause;
$this->useFilteringClause = $useFilteringClause;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function editDataSet($name, $duration, $useDuration, $updateInterval, $effect, $speed, $durationIsPerItem, $itemsSideBySide, $itemsPerPage, $upperLimit, $lowerLimit, $dateFormat, $backgroundColor, $noDataMessage, $template, $css = '', $filter, $ordering, $useOrderingClause, $useFilteringClause, $widgetId)
{
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->updateInterval = $updateInterval;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->itemsSideBySide = $itemsSideBySide;
$this->itemsPerPage = $itemsPerPage;
$this->upperLimit = $upperLimit;
$this->lowerLimit = $lowerLimit;
$this->dateFormat = $dateFormat;
$this->backgroundColor = $backgroundColor;
$this->noDataMessage = $noDataMessage;
$this->template = $template;
$this->css = $css;
$this->filter = $filter;
$this->ordering = $ordering;
$this->useOrderingClause = $useOrderingClause;
$this->useFilteringClause = $useFilteringClause;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"editDataSet",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"updateInterval",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"durationIsPerItem",
",",
"$",
"itemsSideBySide",
",",
"$",
"itemsPerPage",
"... | Edit Ticker widget with dataSet source
@param string $name Optional Widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $updateInterval Update interval in minutes
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)
@param int $durationIsPerItem Flag The duration specified is per item, otherwise it is per feed
@param int $itemsSideBySide Should items be shown side by side
@param int $itemsPerPage When in single mode, how many items per page should be shown
@param int $upperLimit Upper low limit for this dataSet, 0 for nor limit
@param int $lowerLimit lower low limit for this dataSet, 0 for nor limit
@param string $dateFormat The date format to apply to all dates returned by the ticker
@param string $backgroundColor A HEX color to use as the background color of this widget
@param string $noDataMessage A message to display when no data is returned from the source
@param string $template Template for each item, replaces [itemsTemplate] in main template
@param string $css Optional StyleSheet CSS
@param string $filter SQL clause for filter this dataSet
@param string $ordering SQL clause for how this dataSet should be ordered
@param int $useOrderingClause Use advanced order clause - set to 1 if ordering is provided
@param int $useFilteringClause Use advanced filter clause - set to 1 if filter is provided
@param int $widgetId The Widget ID
@return XiboTicker | [
"Edit",
"Ticker",
"widget",
"with",
"dataSet",
"source"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboTicker.php#L270-L298 |
45,203 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSetView.php | XiboDataSetView.create | public function create($dataSetId, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->dataSetId = $dataSetId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating DataSet View widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/dataSetView/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($dataSetId, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->dataSetId = $dataSetId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating DataSet View widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/dataSetView/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"dataSetId",
",",
"$",
"playlistId",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
"->",
"getMe",
"(",
")",
"->",
"getId",
"(",
")",
";",
"$",
"this",
"->",
"... | Create a new dataSetView widget.
@param int $dataSetId The dataSet ID to use as a source for dataSetView widget
@param int $playlistId The playlist ID to which this dataSetView widget should be added
@return XiboDataSetView | [
"Create",
"a",
"new",
"dataSetView",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSetView.php#L110-L119 |
45,204 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSetView.php | XiboDataSetView.edit | public function edit($name, $duration, $useDuration, $dataSetColumnId = [], $updateInterval, $rowsPerPage, $showHeadings, $upperLimit = 0, $lowerLimit = 0, $filter = null, $ordering = null, $templateId = 'empty', $overrideTemplate = 0, $useOrderingClause = 0, $useFilteringClause = 0, $noDataMessage = '', $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->dataSetColumnId = $dataSetColumnId;
$this->updateInterval = $updateInterval;
$this->rowsPerPage = $rowsPerPage;
$this->showHeadings = $showHeadings;
$this->upperLimit = $upperLimit;
$this->lowerLimit = $lowerLimit;
$this->filter = $filter;
$this->ordering = $ordering;
$this->templateId = $templateId;
$this->overrideTemplate = $overrideTemplate;
$this->useOrderingClause = $useOrderingClause;
$this->useFilteringClause = $useFilteringClause;
$this->noDataMessage = $noDataMessage;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId, $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $dataSetColumnId = [], $updateInterval, $rowsPerPage, $showHeadings, $upperLimit = 0, $lowerLimit = 0, $filter = null, $ordering = null, $templateId = 'empty', $overrideTemplate = 0, $useOrderingClause = 0, $useFilteringClause = 0, $noDataMessage = '', $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->dataSetColumnId = $dataSetColumnId;
$this->updateInterval = $updateInterval;
$this->rowsPerPage = $rowsPerPage;
$this->showHeadings = $showHeadings;
$this->upperLimit = $upperLimit;
$this->lowerLimit = $lowerLimit;
$this->filter = $filter;
$this->ordering = $ordering;
$this->templateId = $templateId;
$this->overrideTemplate = $overrideTemplate;
$this->useOrderingClause = $useOrderingClause;
$this->useFilteringClause = $useFilteringClause;
$this->noDataMessage = $noDataMessage;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"dataSetColumnId",
"=",
"[",
"]",
",",
"$",
"updateInterval",
",",
"$",
"rowsPerPage",
",",
"$",
"showHeadings",
",",
"$",
"upperLimit",
"=",
"0",
... | Edit the DataSetView widget.
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag whether to use custom duration
@param array $dataSetColumnId An array of dataSetColumnIds to assign
@param int $updateInterval Widget update interval in minutes
@param int $rowsPerPage Number of rows per page, 0 for no pages
@param int $showHeadings Flag Should the table show the Heading?
@param int $upperLimit Upper row limit for this dataSet, 0 for no limit
@param int $lowerLimit Lower row limit for this dataSet, 0 for no limit
@param string $filter SQL clause to filter the dataSet
@param string $ordering SQL clause to order the dataSet
@param string $templateId Template to apply, available options: empty, light-green
@param int $overrideTemplate Flag whether to override the template
@param int $useOrderingClause Flag whether to use advanced ordering, set to 1 if ordring is provided
@param int $useFilteringClause Flag whether to use advanced filer, set to 1 ifd filter is provided
@param string $noDataMessage A message to display when there is no data returned from the source
@param int $widgetId The Widget ID to edit
@return XiboDataSetView | [
"Edit",
"the",
"DataSetView",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSetView.php#L143-L168 |
45,205 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.get | public function get(array $params = [])
{
$entries = [];
$this->getLogger()->info('Getting list of dataSets ');
$response = $this->doGet($this->url, $params);
foreach ($response as $item) {
$entries[] = clone $this->hydrate($item);
}
return $entries;
} | php | public function get(array $params = [])
{
$entries = [];
$this->getLogger()->info('Getting list of dataSets ');
$response = $this->doGet($this->url, $params);
foreach ($response as $item) {
$entries[] = clone $this->hydrate($item);
}
return $entries;
} | [
"public",
"function",
"get",
"(",
"array",
"$",
"params",
"=",
"[",
"]",
")",
"{",
"$",
"entries",
"=",
"[",
"]",
";",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting list of dataSets '",
")",
";",
"$",
"response",
"=",
"$",
... | Get the list of dataSets.
@param array $params filter the results by: dataSetId, dataSet, code, embeddable parameter embed=columns
@return array|XiboDataSet | [
"Get",
"the",
"list",
"of",
"dataSets",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L119-L130 |
45,206 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.getById | public function getById($id)
{
$this->getLogger()->info('Getting dataSet ID ' . $id);
$response = $this->doGet($this->url, [
'dataSetId' => $id
]);
if (count($response) <= 0)
throw new XiboApiException('Expecting a single record, found ' . count($response));
return clone $this->hydrate($response[0]);
} | php | public function getById($id)
{
$this->getLogger()->info('Getting dataSet ID ' . $id);
$response = $this->doGet($this->url, [
'dataSetId' => $id
]);
if (count($response) <= 0)
throw new XiboApiException('Expecting a single record, found ' . count($response));
return clone $this->hydrate($response[0]);
} | [
"public",
"function",
"getById",
"(",
"$",
"id",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting dataSet ID '",
".",
"$",
"id",
")",
";",
"$",
"response",
"=",
"$",
"this",
"->",
"doGet",
"(",
"$",
"this",
"->",
"ur... | Get the DataSet by DataSetId.
@param int $id the DataSetId to find
@return XiboDataSet
@throws XiboApiException | [
"Get",
"the",
"DataSet",
"by",
"DataSetId",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L139-L150 |
45,207 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.create | public function create($name, $description, $code = '', $isRemote = 0, $method = '', $uri = '', $postData = '', $authentication = '', $username = '', $password = '', $refreshRate = null, $clearRate = null, $runsAfter = null, $dataRoot = '', $summarize = '', $summarizeField = '')
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->dataSet = $name;
$this->description = $description;
$this->code = $code;
$this->isRemote = $isRemote;
$this->method = $method;
$this->uri = $uri;
$this->postData = $postData;
$this->authentication = $authentication;
$this->username = $username;
$this->password = $password;
$this->refreshRate = $refreshRate;
$this->clearRate = $clearRate;
$this->runsAfter = $runsAfter;
$this->dataRoot = $dataRoot;
$this->summarize = $summarize;
$this->summarizeField = $summarizeField;
$this->getLogger()->info('Creating dataSet ' . $name);
$response = $this->doPost('/dataset', $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $description, $code = '', $isRemote = 0, $method = '', $uri = '', $postData = '', $authentication = '', $username = '', $password = '', $refreshRate = null, $clearRate = null, $runsAfter = null, $dataRoot = '', $summarize = '', $summarizeField = '')
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->dataSet = $name;
$this->description = $description;
$this->code = $code;
$this->isRemote = $isRemote;
$this->method = $method;
$this->uri = $uri;
$this->postData = $postData;
$this->authentication = $authentication;
$this->username = $username;
$this->password = $password;
$this->refreshRate = $refreshRate;
$this->clearRate = $clearRate;
$this->runsAfter = $runsAfter;
$this->dataRoot = $dataRoot;
$this->summarize = $summarize;
$this->summarizeField = $summarizeField;
$this->getLogger()->info('Creating dataSet ' . $name);
$response = $this->doPost('/dataset', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"code",
"=",
"''",
",",
"$",
"isRemote",
"=",
"0",
",",
"$",
"method",
"=",
"''",
",",
"$",
"uri",
"=",
"''",
",",
"$",
"postData",
"=",
"''",
",",
"$",
"authe... | Create the DataSet.
@param string $name New name for the dataSet
@param string $description New Description for the dataSet
@param string $code New code for this DataSet
@param int $isRemote Flag (0, 1) is this remote DataSet?
@param string $method For isRemote=1, The Request Method GET or POST
@param string $uri For isRemote=1, The URI, without query parameters
@param string $postData For isRemote=1, Query parameter encoded data to add to the request
@param string $authentication For isRemote=1, HTTP Authentication method None|Basic|Digest
@param string $username for isRemote=1, HTTP Authentication User Name
@param string $password for isRemote=1, HTTP Authentication Password
@param int $refreshRate for isRemote=1, How often in seconds should this remote DataSet be refreshed
@param int $clearRate for isRemote=1, How often in seconds should this remote DataSet be truncated
@param int $runsAfter for isRemote=1, Optional dataSetId which should be run before this remote DataSet
@param string $dataRoot for isRemote=1, The root of the data in the Remote source which is used as the base for all remote columns
@param string $summarize for isRemote=1, Should the data be aggregated? None|Summarize|Count
@param string $summarizeField for isRemote=1, Which field should be used to summarize
@return XiboDataSet | [
"Create",
"the",
"DataSet",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L173-L197 |
45,208 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.edit | public function edit($dataSetId, $name, $description, $code = '', $isRemote = 0, $method = '', $uri = '', $postData = '', $authentication = '', $username = '', $password = '', $refreshRate = null, $clearRate = null, $runsAfter = null, $dataRoot = '', $summarize = '', $summarizeField = '')
{
$this->dataSetId = $dataSetId;
$this->dataSet = $name;
$this->description = $description;
$this->code = $code;
$this->isRemote = $isRemote;
$this->method = $method;
$this->uri = $uri;
$this->postData = $postData;
$this->authentication = $authentication;
$this->username = $username;
$this->password = $password;
$this->refreshRate = $refreshRate;
$this->clearRate = $clearRate;
$this->runsAfter = $runsAfter;
$this->dataRoot = $dataRoot;
$this->summarize = $summarize;
$this->summarizeField = $summarizeField;
$this->getLogger()->info('Editing dataSet ID ' . $this->dataSetId);
$response = $this->doPut('/dataset/' . $dataSetId, $this->toArray());
return $this->hydrate($response);
} | php | public function edit($dataSetId, $name, $description, $code = '', $isRemote = 0, $method = '', $uri = '', $postData = '', $authentication = '', $username = '', $password = '', $refreshRate = null, $clearRate = null, $runsAfter = null, $dataRoot = '', $summarize = '', $summarizeField = '')
{
$this->dataSetId = $dataSetId;
$this->dataSet = $name;
$this->description = $description;
$this->code = $code;
$this->isRemote = $isRemote;
$this->method = $method;
$this->uri = $uri;
$this->postData = $postData;
$this->authentication = $authentication;
$this->username = $username;
$this->password = $password;
$this->refreshRate = $refreshRate;
$this->clearRate = $clearRate;
$this->runsAfter = $runsAfter;
$this->dataRoot = $dataRoot;
$this->summarize = $summarize;
$this->summarizeField = $summarizeField;
$this->getLogger()->info('Editing dataSet ID ' . $this->dataSetId);
$response = $this->doPut('/dataset/' . $dataSetId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"dataSetId",
",",
"$",
"name",
",",
"$",
"description",
",",
"$",
"code",
"=",
"''",
",",
"$",
"isRemote",
"=",
"0",
",",
"$",
"method",
"=",
"''",
",",
"$",
"uri",
"=",
"''",
",",
"$",
"postData",
"=",
"... | Edit the DataSet.
@param int $dataSetId The Id of the dataSet to edit
@param string $name New name for the dataSet
@param string $description New Description for the dataSet
@param string $code New code for this DataSet
@param int $isRemote Flag (0, 1) is this remote DataSet?
@param string $method For isRemote=1, The Request Method GET or POST
@param string $uri For isRemote=1, The URI, without query parameters
@param string $postData For isRemote=1, Query parameter encoded data to add to the request
@param string $authentication For isRemote=1, HTTP Authentication method None|Basic|Digest
@param string $username for isRemote=1, HTTP Authentication User Name
@param string $password for isRemote=1, HTTP Authentication Password
@param int $refreshRate for isRemote=1, How often in seconds should this remote DataSet be refreshed
@param int $clearRate for isRemote=1, How often in seconds should this remote DataSet be truncated
@param int $runsAfter for isRemote=1, Optional dataSetId which should be run before this remote DataSet
@param string $dataRoot for isRemote=1, The root of the data in the Remote source which is used as the base for all remote columns
@param string $summarize for isRemote=1, Should the data be aggregated? None|Summarize|Count
@param string $summarizeField for isRemote=1, Which field should be used to summarize
@return XiboDataSet | [
"Edit",
"the",
"DataSet",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L221-L245 |
45,209 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.deleteWData | public function deleteWData()
{
$this->getLogger()->info('Forcefully deleting dataSet ID ' . $this->dataSetId);
$this->doDelete('/dataset/' . $this->dataSetId, [
'deleteData' => 1
]);
return true;
} | php | public function deleteWData()
{
$this->getLogger()->info('Forcefully deleting dataSet ID ' . $this->dataSetId);
$this->doDelete('/dataset/' . $this->dataSetId, [
'deleteData' => 1
]);
return true;
} | [
"public",
"function",
"deleteWData",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Forcefully deleting dataSet ID '",
".",
"$",
"this",
"->",
"dataSetId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/dataset/'",
".",
"$"... | Force delete dataSet that contains a data in it.
@return bool | [
"Force",
"delete",
"dataSet",
"that",
"contains",
"a",
"data",
"in",
"it",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L266-L274 |
45,210 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.copy | public function copy($dataSetId, $dataSet, $description = '', $code ='')
{
$this->dataSetId = $dataSetId;
$this->dataSet = $dataSet;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Copy dataSet ID ' . $dataSetId);
$response = $this->doPost('/dataset/copy/' . $dataSetId, $this->toArray());
return $this->hydrate($response);
} | php | public function copy($dataSetId, $dataSet, $description = '', $code ='')
{
$this->dataSetId = $dataSetId;
$this->dataSet = $dataSet;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Copy dataSet ID ' . $dataSetId);
$response = $this->doPost('/dataset/copy/' . $dataSetId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"copy",
"(",
"$",
"dataSetId",
",",
"$",
"dataSet",
",",
"$",
"description",
"=",
"''",
",",
"$",
"code",
"=",
"''",
")",
"{",
"$",
"this",
"->",
"dataSetId",
"=",
"$",
"dataSetId",
";",
"$",
"this",
"->",
"dataSet",
"=",
"$",... | Copy DataSet.
@param int $dataSetId Id of the dataSet to copy
@param string $dataSet Name of the copied dataSet
@param string $description Description of the copied dataSet
@param string $code Code for the new dataSet
@return XiboDataSet | [
"Copy",
"DataSet",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L285-L296 |
45,211 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.editColumn | public function editColumn($heading, $listContent, $columnOrder, $dataTypeId, $dataSetColumnTypeId, $formula, $remoteField = '', $showFilter = 0, $showSort = 0)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->heading = $heading;
$this->listContent = $listContent;
$this->columnOrder = $columnOrder;
$this->dataTypeId = $dataTypeId;
$this->dataSetColumnTypeId = $dataSetColumnTypeId;
$this->formula = $formula;
$this->remoteField = $remoteField;
$this->showFilter = $showFilter;
$this->showSort = $showSort;
$this->getLogger()->info('Editing column ID ' . $this->dataSetColumnId . ' From dataSet ID ' . $this->dataSetId);
$response = $this->doPut('/dataset/'. $this->dataSetId . '/column/' . $this->dataSetColumnId, $this->toArray());
return $this->hydrate($response);
} | php | public function editColumn($heading, $listContent, $columnOrder, $dataTypeId, $dataSetColumnTypeId, $formula, $remoteField = '', $showFilter = 0, $showSort = 0)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->heading = $heading;
$this->listContent = $listContent;
$this->columnOrder = $columnOrder;
$this->dataTypeId = $dataTypeId;
$this->dataSetColumnTypeId = $dataSetColumnTypeId;
$this->formula = $formula;
$this->remoteField = $remoteField;
$this->showFilter = $showFilter;
$this->showSort = $showSort;
$this->getLogger()->info('Editing column ID ' . $this->dataSetColumnId . ' From dataSet ID ' . $this->dataSetId);
$response = $this->doPut('/dataset/'. $this->dataSetId . '/column/' . $this->dataSetColumnId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"editColumn",
"(",
"$",
"heading",
",",
"$",
"listContent",
",",
"$",
"columnOrder",
",",
"$",
"dataTypeId",
",",
"$",
"dataSetColumnTypeId",
",",
"$",
"formula",
",",
"$",
"remoteField",
"=",
"''",
",",
"$",
"showFilter",
"=",
"0",
... | Edit Column.
@param string $heading The heading for the column
@param string $listContent A comma separated list of content for dropdowns
@param int $columnOrder Display order for this column
@param int $dataTypeId The data type ID for this column 1 - String, 2 - Number, 3 - Date, 4 - External Image, 5 - Internal Image
@param int $dataSetColumnTypeId The column type for this column 1 - Value, 2 - Formula, 3 - Remote
@param string $formula MySQL SELECT syntax formula for this column if the column type is set to formula
@param string $remoteField Only for dataSetColumnTypeId=3, JSON-String to select Data from the remote DataSet
@param int $showFilter Flag indicating whether this column should present a filter on DataEntry
@param int $showSort Flag indicating whether this column should allow sorting on DataEntry
@return XiboDataSet
@return XiboDataSet | [
"Edit",
"Column",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L368-L385 |
45,212 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSet.php | XiboDataSet.deleteColumn | public function deleteColumn()
{
$this->getLogger()->info('Deleting column ID ' . $this->dataSetColumnId . ' From dataSet ID ' . $this->dataSetId);
$this->doDelete('/dataset/' . $this->dataSetId . '/column/' . $this->dataSetColumnId);
return true;
} | php | public function deleteColumn()
{
$this->getLogger()->info('Deleting column ID ' . $this->dataSetColumnId . ' From dataSet ID ' . $this->dataSetId);
$this->doDelete('/dataset/' . $this->dataSetId . '/column/' . $this->dataSetColumnId);
return true;
} | [
"public",
"function",
"deleteColumn",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting column ID '",
".",
"$",
"this",
"->",
"dataSetColumnId",
".",
"' From dataSet ID '",
".",
"$",
"this",
"->",
"dataSetId",
")",
";",
... | Delete Column.
@return bool | [
"Delete",
"Column",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSet.php#L392-L398 |
45,213 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSetRow.php | XiboDataSetRow.get | public function get($dataSetId)
{
$this->dataSetId = $dataSetId;
$this->getLogger()->info('Getting row data from dataSet ID ' . $dataSetId);
$response = $this->doGet('/dataset/data/'. $this->dataSetId);
return $response;
} | php | public function get($dataSetId)
{
$this->dataSetId = $dataSetId;
$this->getLogger()->info('Getting row data from dataSet ID ' . $dataSetId);
$response = $this->doGet('/dataset/data/'. $this->dataSetId);
return $response;
} | [
"public",
"function",
"get",
"(",
"$",
"dataSetId",
")",
"{",
"$",
"this",
"->",
"dataSetId",
"=",
"$",
"dataSetId",
";",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting row data from dataSet ID '",
".",
"$",
"dataSetId",
")",
";",
... | Get a data for the specified dataSetId.
@param int $dataSetId The DataSetId
@return XiboDataSetRow | [
"Get",
"a",
"data",
"for",
"the",
"specified",
"dataSetId",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSetRow.php#L50-L57 |
45,214 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSetRow.php | XiboDataSetRow.create | public function create($dataSetId, $columnId, $rowData)
{
$this->dataSetId = $dataSetId;
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->getLogger()->info('Creating row in dataSet ID ' . $dataSetId . ' Column ID ' . $columnId);
$response = $this->doPost('/dataset/data/'. $dataSetId, [
'dataSetColumnId_' . $columnId => $rowData
]);
return $response;
} | php | public function create($dataSetId, $columnId, $rowData)
{
$this->dataSetId = $dataSetId;
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->getLogger()->info('Creating row in dataSet ID ' . $dataSetId . ' Column ID ' . $columnId);
$response = $this->doPost('/dataset/data/'. $dataSetId, [
'dataSetColumnId_' . $columnId => $rowData
]);
return $response;
} | [
"public",
"function",
"create",
"(",
"$",
"dataSetId",
",",
"$",
"columnId",
",",
"$",
"rowData",
")",
"{",
"$",
"this",
"->",
"dataSetId",
"=",
"$",
"dataSetId",
";",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
... | Create Row.
@param string $rowData The data to add to the specified column
@param int $dataSetId The DataSetId
@param int $columnId The dataSetColumnId
@return XiboDataSetRow | [
"Create",
"Row",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSetRow.php#L67-L77 |
45,215 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDataSetRow.php | XiboDataSetRow.edit | public function edit($dataSetId, $columnId, $rowData)
{
$this->dataSetId = $dataSetId;
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->getLogger()->info('Editing row ID' . $this->rowId . ' In dataSet ID ' . $dataSetId . ' Column ID' . $columnId);
$response = $this->doPut('/dataset/data/'. $this->dataSetId . $this->rowId, [
'dataSetColumnId_' . $columnId => $rowData
]);
return $response;
} | php | public function edit($dataSetId, $columnId, $rowData)
{
$this->dataSetId = $dataSetId;
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->getLogger()->info('Editing row ID' . $this->rowId . ' In dataSet ID ' . $dataSetId . ' Column ID' . $columnId);
$response = $this->doPut('/dataset/data/'. $this->dataSetId . $this->rowId, [
'dataSetColumnId_' . $columnId => $rowData
]);
return $response;
} | [
"public",
"function",
"edit",
"(",
"$",
"dataSetId",
",",
"$",
"columnId",
",",
"$",
"rowData",
")",
"{",
"$",
"this",
"->",
"dataSetId",
"=",
"$",
"dataSetId",
";",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
... | Edit Row.
@param string $rowData The data to edit to the specified column
@param int $dataSetId The DataSetId
@param int $columnId The dataSetColumnId
@return XiboDataSetRow | [
"Edit",
"Row",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDataSetRow.php#L87-L97 |
45,216 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCampaign.php | XiboCampaign.create | public function create($campaign)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->ownerId = $this->getEntityProvider()->getMe()->getId();
$this->campaign = $campaign;
// Rewrite parameter mismatch
$array = $this->toArray();
$array['name'] = $array['campaign'];
$this->getLogger()->info('Creating Campaign ' . $this->campaign);
$response = $this->doPost($this->url, $array);
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | php | public function create($campaign)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->ownerId = $this->getEntityProvider()->getMe()->getId();
$this->campaign = $campaign;
// Rewrite parameter mismatch
$array = $this->toArray();
$array['name'] = $array['campaign'];
$this->getLogger()->info('Creating Campaign ' . $this->campaign);
$response = $this->doPost($this->url, $array);
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"campaign",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"debug",
"(",
"'Getting Resource Owner'",
")",
";",
"$",
"this",
"->",
"ownerId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
"->",... | Add a new campaign with specified name.
@param string $campaign name of the campaign
@return XiboCampaign | [
"Add",
"a",
"new",
"campaign",
"with",
"specified",
"name",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCampaign.php#L98-L112 |
45,217 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCampaign.php | XiboCampaign.edit | public function edit($campaign)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->ownerId = $this->getEntityProvider()->getMe()->getId();
$this->campaign = $campaign;
// Rewrite parameter mismatch
$array = $this->toArray();
$array['name'] = $array['campaign'];
$this->getLogger()->info('Editing Campaign ID ' . $this->campaignId);
$response = $this->doPut($this->url . '/' . $this->campaignId, $array);
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | php | public function edit($campaign)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->ownerId = $this->getEntityProvider()->getMe()->getId();
$this->campaign = $campaign;
// Rewrite parameter mismatch
$array = $this->toArray();
$array['name'] = $array['campaign'];
$this->getLogger()->info('Editing Campaign ID ' . $this->campaignId);
$response = $this->doPut($this->url . '/' . $this->campaignId, $array);
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"campaign",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"debug",
"(",
"'Getting Resource Owner'",
")",
";",
"$",
"this",
"->",
"ownerId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
"->",
... | Edit campaign and change its name to the specified one.
@param string $campaign name of the campaign
@return XiboCampaign | [
"Edit",
"campaign",
"and",
"change",
"its",
"name",
"to",
"the",
"specified",
"one",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCampaign.php#L120-L134 |
45,218 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCampaign.php | XiboCampaign.delete | public function delete()
{
$this->getLogger()->info('Deleting Campaign ID ' . $this->campaignId);
$this->doDelete($this->url . '/' . $this->campaignId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting Campaign ID ' . $this->campaignId);
$this->doDelete($this->url . '/' . $this->campaignId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting Campaign ID '",
".",
"$",
"this",
"->",
"campaignId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"$",
"this",
"->",
"url",
".",
... | Deletes the campaign.
@return bool | [
"Deletes",
"the",
"campaign",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCampaign.php#L141-L147 |
45,219 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCampaign.php | XiboCampaign.assignLayout | public function assignLayout($layoutId = [], $displayOrder = [], $unassignLayoutId = [])
{
// TODO Check if $layoutId and $displayOrderId have the same length, throw error otherwise
if ($layoutId != [] && $unassignLayoutId == []) {
for ($i = 0; $i < count($layoutId); $i++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'layoutId' => [
[
'layoutId' => $layoutId[$i],
'displayOrder' => $displayOrder[$i]
]
]
]);
$this->getLogger()->info('Assigning Layout ID ' . $layoutId[$i] . ' To Campaign ID ' . $this->campaignId);
}
} elseif ($layoutId != [] && $unassignLayoutId != []) {
for ($i = 0; $i < count($layoutId); $i++) {
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'layoutId' => [
[
'layoutId' => $layoutId[$i],
'displayOrder' => $displayOrder[$i]
]
],
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Assigning Layout ID ' . $layoutId[$i] . ' To Campaign ID ' . $this->campaignId);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
}
} elseif ($layoutId == [] && $unassignLayoutId != []) {
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
}
// TODO Throw an error if nothing is passed / found
return $this;
} | php | public function assignLayout($layoutId = [], $displayOrder = [], $unassignLayoutId = [])
{
// TODO Check if $layoutId and $displayOrderId have the same length, throw error otherwise
if ($layoutId != [] && $unassignLayoutId == []) {
for ($i = 0; $i < count($layoutId); $i++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'layoutId' => [
[
'layoutId' => $layoutId[$i],
'displayOrder' => $displayOrder[$i]
]
]
]);
$this->getLogger()->info('Assigning Layout ID ' . $layoutId[$i] . ' To Campaign ID ' . $this->campaignId);
}
} elseif ($layoutId != [] && $unassignLayoutId != []) {
for ($i = 0; $i < count($layoutId); $i++) {
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'layoutId' => [
[
'layoutId' => $layoutId[$i],
'displayOrder' => $displayOrder[$i]
]
],
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Assigning Layout ID ' . $layoutId[$i] . ' To Campaign ID ' . $this->campaignId);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
}
} elseif ($layoutId == [] && $unassignLayoutId != []) {
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$response = $this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
}
// TODO Throw an error if nothing is passed / found
return $this;
} | [
"public",
"function",
"assignLayout",
"(",
"$",
"layoutId",
"=",
"[",
"]",
",",
"$",
"displayOrder",
"=",
"[",
"]",
",",
"$",
"unassignLayoutId",
"=",
"[",
"]",
")",
"{",
"// TODO Check if $layoutId and $displayOrderId have the same length, throw error otherwise",
"if... | Assign layout to the campaign.
@param array $layoutId Array of layouts Ids to assign to this campaign
@param array $displayOrder Array of Display Order numbers for the layouts to assign
@param array $unassignLayoutId Array of layouts Ids to unassign from the campaign
@return XiboCampaign | [
"Assign",
"layout",
"to",
"the",
"campaign",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCampaign.php#L157-L209 |
45,220 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCampaign.php | XiboCampaign.unassignLayout | public function unassignLayout($unassignLayoutId = [])
{
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
return $this;
} | php | public function unassignLayout($unassignLayoutId = [])
{
for ($j = 0; $j < count($unassignLayoutId); $j++) {
$this->doPost('/campaign/layout/assign/' . $this->campaignId, [
'unassignLayoutId' => [
[
'layoutId' => $unassignLayoutId[$j],
]
]
]);
$this->getLogger()->info('Removing assignment Layout ID ' . $unassignLayoutId[$j] . ' From Campaign ID ' . $this->campaignId);
}
return $this;
} | [
"public",
"function",
"unassignLayout",
"(",
"$",
"unassignLayoutId",
"=",
"[",
"]",
")",
"{",
"for",
"(",
"$",
"j",
"=",
"0",
";",
"$",
"j",
"<",
"count",
"(",
"$",
"unassignLayoutId",
")",
";",
"$",
"j",
"++",
")",
"{",
"$",
"this",
"->",
"doPo... | Unassign layout from the campaign.
@param array $unassignLayoutId Array of layouts Ids to unassign from the campaign
@return XiboCampaign | [
"Unassign",
"layout",
"from",
"the",
"campaign",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCampaign.php#L217-L232 |
45,221 | xibosignage/oauth2-xibo-cms | src/Entity/XiboShellCommand.php | XiboShellCommand.create | public function create($name, $duration, $useDuration, $windowsCommand, $linuxCommand, $launchThroughCmd, $terminateCommand, $useTaskkill, $commandCode, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->windowsCommand = $windowsCommand;
$this->linuxCommand = $linuxCommand;
$this->launchThroughCmd = $launchThroughCmd;
$this->terminateCommand = $terminateCommand;
$this->useTaskkill = $useTaskkill;
$this->commandCode = $commandCode;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating new Schell Command widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/shellCommand/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $windowsCommand, $linuxCommand, $launchThroughCmd, $terminateCommand, $useTaskkill, $commandCode, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->windowsCommand = $windowsCommand;
$this->linuxCommand = $linuxCommand;
$this->launchThroughCmd = $launchThroughCmd;
$this->terminateCommand = $terminateCommand;
$this->useTaskkill = $useTaskkill;
$this->commandCode = $commandCode;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating new Schell Command widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/shellCommand/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"windowsCommand",
",",
"$",
"linuxCommand",
",",
"$",
"launchThroughCmd",
",",
"$",
"terminateCommand",
",",
"$",
"useTaskkill",
",",
"$",
"commandCode... | Create new Shell Command Widget.
@param string $name Optional widget name
@param int $duration Widget duration
@param int $useDuration Flag indicating whether to use custom duration
@param string $windowsCommand Enter a Windows command line compatible command
@param string $linuxCommand Enter a Android / Linux command line compatible command
@param int $launchThroughCmd Flag Windows only, Should the player launch this command through the windows command line (cmd.exe)? This is useful for batch files, if you try to terminate this command only the command line will be terminated
@param int $terminateCommand Flag Should the player forcefully terminate the command after the duration specified, 0 to let the command terminate naturally
@param int $useTaskkill Flag Windows only, should the player use taskkill to terminate commands
@param string $commandCode Enter a reference code for exiting command in CMS
@param int $playlistId Playlist ID
@return XiboShellCommand | [
"Create",
"new",
"Shell",
"Command",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboShellCommand.php#L88-L105 |
45,222 | xibosignage/oauth2-xibo-cms | src/Entity/XiboShellCommand.php | XiboShellCommand.edit | public function edit($name, $duration, $useDuration, $windowsCommand, $linuxCommand, $launchThroughCmd, $terminateCommand, $useTaskkill, $commandCode, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->windowsCommand = $windowsCommand;
$this->linuxCommand = $linuxCommand;
$this->launchThroughCmd = $launchThroughCmd;
$this->terminateCommand = $terminateCommand;
$this->useTaskkill = $useTaskkill;
$this->commandCode = $commandCode;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing a widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $windowsCommand, $linuxCommand, $launchThroughCmd, $terminateCommand, $useTaskkill, $commandCode, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->windowsCommand = $windowsCommand;
$this->linuxCommand = $linuxCommand;
$this->launchThroughCmd = $launchThroughCmd;
$this->terminateCommand = $terminateCommand;
$this->useTaskkill = $useTaskkill;
$this->commandCode = $commandCode;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing a widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"windowsCommand",
",",
"$",
"linuxCommand",
",",
"$",
"launchThroughCmd",
",",
"$",
"terminateCommand",
",",
"$",
"useTaskkill",
",",
"$",
"commandCode",... | Edit existing Shell Command Widget.
@param string $name Optional widget name
@param int $duration Widget duration
@param int $useDuration Flag indicating whether to use custom duration
@param string $windowsCommand Enter a Windows command line compatible command
@param string $linuxCommand Enter a Android / Linux command line compatible command
@param int $launchThroughCmd Flag Windows only, Should the player launch this command through the windows command line (cmd.exe)? This is useful for batch files, if you try to terminate this command only the command line will be terminated
@param int $terminateCommand Flag Should the player forcefully terminate the command after the duration specified, 0 to let the command terminate naturally
@param int $useTaskkill Flag Windows only, should the player use taskkill to terminate commands
@param string $commandCode Enter a reference code for exiting command in CMS
@param int $widgetId the Widget ID
@return XiboShellCommand | [
"Edit",
"existing",
"Shell",
"Command",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboShellCommand.php#L122-L139 |
45,223 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.create | public function create($name, $fileLocation, $oldMediaId = null, $updateInLayouts = null, $deleteOldRevisions = null)
{
$this->getLogger()->debug('Preparing media payload ');
$payload = [
[
'name' => 'name',
'contents' => $name
],
[
'name' => 'files',
'contents' => fopen($fileLocation, 'r')
]
];
$this->getLogger()->info('Uploading new media file ' . $name);
if ($oldMediaId != null) {
$this->getLogger()->debug('Replacing old media ID ' .$oldMediaId);
$payload[] = [
'name' => 'oldMediaId',
'contents' => $oldMediaId
];
$this->getLogger()->debug('Updating Media in all layouts it is assigned to');
$payload[] = [
'name' => 'updateInLayouts',
'contents' => $updateInLayouts
];
$this->getLogger()->debug('Deleting Old Revisions');
$payload[] = [
'name' => 'deleteOldRevisions',
'contents' => $deleteOldRevisions
];
}
$response = $this->doPost('/library', ['multipart' => $payload]);
if (isset($response['files'][0]['mediaId']))
$this->getLogger()->debug('Uploaded media ' . $response['files'][0]['name'] . ' Media ID ' . $response['files'][0]['mediaId'] . ' Stored as ' . $response['files'][0]['storedas']);
// Response will have the format:
/*{
"files":[{
"name": "Name",
"size": 52770969,
"type": "video/mp4",
"mediaId": 2344,
"storedas": "2344.mp4",
"error": ""
}]
}*/
if (!isset($response['files']) || count($response['files']) != 1)
throw new XiboApiException('Invalid return from library add');
if (!empty($response['files'][0]['error']))
throw new XiboApiException($response['files'][0]['error']);
// Modify some of the return
unset($response['files'][0]['url']);
$response['files'][0]['storedAs'] = $response['files'][0]['storedas'];
$media = new XiboLibrary($this->getEntityProvider());
return $media->hydrate($response['files'][0]);
} | php | public function create($name, $fileLocation, $oldMediaId = null, $updateInLayouts = null, $deleteOldRevisions = null)
{
$this->getLogger()->debug('Preparing media payload ');
$payload = [
[
'name' => 'name',
'contents' => $name
],
[
'name' => 'files',
'contents' => fopen($fileLocation, 'r')
]
];
$this->getLogger()->info('Uploading new media file ' . $name);
if ($oldMediaId != null) {
$this->getLogger()->debug('Replacing old media ID ' .$oldMediaId);
$payload[] = [
'name' => 'oldMediaId',
'contents' => $oldMediaId
];
$this->getLogger()->debug('Updating Media in all layouts it is assigned to');
$payload[] = [
'name' => 'updateInLayouts',
'contents' => $updateInLayouts
];
$this->getLogger()->debug('Deleting Old Revisions');
$payload[] = [
'name' => 'deleteOldRevisions',
'contents' => $deleteOldRevisions
];
}
$response = $this->doPost('/library', ['multipart' => $payload]);
if (isset($response['files'][0]['mediaId']))
$this->getLogger()->debug('Uploaded media ' . $response['files'][0]['name'] . ' Media ID ' . $response['files'][0]['mediaId'] . ' Stored as ' . $response['files'][0]['storedas']);
// Response will have the format:
/*{
"files":[{
"name": "Name",
"size": 52770969,
"type": "video/mp4",
"mediaId": 2344,
"storedas": "2344.mp4",
"error": ""
}]
}*/
if (!isset($response['files']) || count($response['files']) != 1)
throw new XiboApiException('Invalid return from library add');
if (!empty($response['files'][0]['error']))
throw new XiboApiException($response['files'][0]['error']);
// Modify some of the return
unset($response['files'][0]['url']);
$response['files'][0]['storedAs'] = $response['files'][0]['storedas'];
$media = new XiboLibrary($this->getEntityProvider());
return $media->hydrate($response['files'][0]);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"fileLocation",
",",
"$",
"oldMediaId",
"=",
"null",
",",
"$",
"updateInLayouts",
"=",
"null",
",",
"$",
"deleteOldRevisions",
"=",
"null",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
... | Upload new media.
Upload new media file to the CMS library.
@param string $name optional media name
@param string $fileLocation location of the file
@param int $oldMediaId Id of an existing media file which should be replaced with the new upload
@param int $updateInLayouts Flag set to 1 to update this media in all layouts (use with oldMediaId)
@param int $deleteOldRevisions Flag to either remove or leave the old file revisions (use with oldMediaId)
@return XiboLibrary
@throws XiboApiException | [
"Upload",
"new",
"media",
".",
"Upload",
"new",
"media",
"file",
"to",
"the",
"CMS",
"library",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L137-L193 |
45,224 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.revise | public function revise($fileLocation)
{
$this->getLogger()->info('Revising file');
return $this->create($this->name, $fileLocation, $this->mediaId, $this->updateInLayouts, $this->deleteOldRevisions);
} | php | public function revise($fileLocation)
{
$this->getLogger()->info('Revising file');
return $this->create($this->name, $fileLocation, $this->mediaId, $this->updateInLayouts, $this->deleteOldRevisions);
} | [
"public",
"function",
"revise",
"(",
"$",
"fileLocation",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Revising file'",
")",
";",
"return",
"$",
"this",
"->",
"create",
"(",
"$",
"this",
"->",
"name",
",",
"$",
"fileLocation... | Revise specified file.
@param string $fileLocation location of the file
@return XiboLibrary
@throws XiboApiException | [
"Revise",
"specified",
"file",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L203-L207 |
45,225 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.edit | public function edit($name, $duration, $retired, $tags, $updateInLayouts)
{
$this->name = $name;
$this->duration = $duration;
$this->retired = $retired;
$this->tags = $tags;
$this->updateInLayouts = $updateInLayouts;
$this->getLogger()->info('Editing Media ID ' . $this->mediaId);
$response = $this->doPut('/library/' . $this->mediaId, $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $retired, $tags, $updateInLayouts)
{
$this->name = $name;
$this->duration = $duration;
$this->retired = $retired;
$this->tags = $tags;
$this->updateInLayouts = $updateInLayouts;
$this->getLogger()->info('Editing Media ID ' . $this->mediaId);
$response = $this->doPut('/library/' . $this->mediaId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"retired",
",",
"$",
"tags",
",",
"$",
"updateInLayouts",
")",
"{",
"$",
"this",
"->",
"name",
"=",
"$",
"name",
";",
"$",
"this",
"->",
"duration",
"=",
"$",
"duration... | Edit existing media file.
@param string $name optional media name
@param int $duration Media duration
@param int $retired Flag indicating if this media is retired
@param string $tags Comma separated list of Tags
@param int $updateInLayouts Flag indicating whether to update the duration in all Layouts the Media is assigned to
@return XiboLibrary | [
"Edit",
"existing",
"media",
"file",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L219-L230 |
45,226 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.delete | public function delete()
{
$this->getLogger()->info('Deleting media ID ' . $this->mediaId);
$this->doDelete('/library/' . $this->mediaId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting media ID ' . $this->mediaId);
$this->doDelete('/library/' . $this->mediaId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting media ID '",
".",
"$",
"this",
"->",
"mediaId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/library/'",
".",
"$",
"this",
"->",
... | Delete the media.
@return bool | [
"Delete",
"the",
"media",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L237-L243 |
45,227 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.deleteAssigned | public function deleteAssigned()
{
$this->getLogger()->info('Force deleting assigned media ID ' . $this->mediaId);
$this->doDelete('/library/' . $this->mediaId, [
'forceDelete' => 1
]);
return true;
} | php | public function deleteAssigned()
{
$this->getLogger()->info('Force deleting assigned media ID ' . $this->mediaId);
$this->doDelete('/library/' . $this->mediaId, [
'forceDelete' => 1
]);
return true;
} | [
"public",
"function",
"deleteAssigned",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Force deleting assigned media ID '",
".",
"$",
"this",
"->",
"mediaId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/library/'",
".",
... | Delete assigned media.
@return bool | [
"Delete",
"assigned",
"media",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L250-L258 |
45,228 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.AddTag | public function AddTag($tag)
{
$this->tag = $tag;
$response = $this->doPost('/library/' . $this->mediaId . '/tag', [
'tag' => [$tag]
]);
$tags = $this->hydrate($response);
foreach ($response['tags'] as $item) {
$tag = new XiboLibrary($this->getEntityProvider());
$tag->hydrate($item);
$tags->tags[] = $tag;
}
return $this;
} | php | public function AddTag($tag)
{
$this->tag = $tag;
$response = $this->doPost('/library/' . $this->mediaId . '/tag', [
'tag' => [$tag]
]);
$tags = $this->hydrate($response);
foreach ($response['tags'] as $item) {
$tag = new XiboLibrary($this->getEntityProvider());
$tag->hydrate($item);
$tags->tags[] = $tag;
}
return $this;
} | [
"public",
"function",
"AddTag",
"(",
"$",
"tag",
")",
"{",
"$",
"this",
"->",
"tag",
"=",
"$",
"tag",
";",
"$",
"response",
"=",
"$",
"this",
"->",
"doPost",
"(",
"'/library/'",
".",
"$",
"this",
"->",
"mediaId",
".",
"'/tag'",
",",
"[",
"'tag'",
... | Add tag.
Adds specified tag to the specified media
@param string $tag name of the tag to add
@return XiboLibrary | [
"Add",
"tag",
".",
"Adds",
"specified",
"tag",
"to",
"the",
"specified",
"media"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L267-L281 |
45,229 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.removeTag | public function removeTag($tag)
{
$this->tag = $tag;
$this->getLogger()->info('Removing tag: ' . $tag . ' from layout ID ' . $this->mediaId);
$this->doPost('/library/' . $this->mediaId . '/untag', [
'tag' => [$tag]
]);
return $this;
} | php | public function removeTag($tag)
{
$this->tag = $tag;
$this->getLogger()->info('Removing tag: ' . $tag . ' from layout ID ' . $this->mediaId);
$this->doPost('/library/' . $this->mediaId . '/untag', [
'tag' => [$tag]
]);
return $this;
} | [
"public",
"function",
"removeTag",
"(",
"$",
"tag",
")",
"{",
"$",
"this",
"->",
"tag",
"=",
"$",
"tag",
";",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Removing tag: '",
".",
"$",
"tag",
".",
"' from layout ID '",
".",
"$",
"this... | Remove tag.
Removes specified tag from the specified media
@param string $tag name of the taf to remove
@return XiboLibrary | [
"Remove",
"tag",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L290-L299 |
45,230 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.download | public function download($mediaId, $type, $filePath, $fileName)
{
$this->mediaId = $mediaId;
$this->mediaType = $type;
$this->getLogger()->info('Downloading media ID ' . $mediaId . ' and saving it in ' . $filePath . ' as ' . $fileName);
$response = $this->doGet('/library/download/' . $this->mediaId . '/' . $this->mediaType);
// Check if the directory exists, if not create it
$this->getLogger()->debug('Checking if the directory exists');
if (!file_exists($filePath)) {
$this->getLogger()->debug('Creating directory to save files to ' . $filePath);
mkdir($filePath, 0777, true);
}
// Save file to the directory with the provided name
$file = fopen($filePath . $fileName, 'w');
fwrite($file, $response);
fclose($file);
return true;
} | php | public function download($mediaId, $type, $filePath, $fileName)
{
$this->mediaId = $mediaId;
$this->mediaType = $type;
$this->getLogger()->info('Downloading media ID ' . $mediaId . ' and saving it in ' . $filePath . ' as ' . $fileName);
$response = $this->doGet('/library/download/' . $this->mediaId . '/' . $this->mediaType);
// Check if the directory exists, if not create it
$this->getLogger()->debug('Checking if the directory exists');
if (!file_exists($filePath)) {
$this->getLogger()->debug('Creating directory to save files to ' . $filePath);
mkdir($filePath, 0777, true);
}
// Save file to the directory with the provided name
$file = fopen($filePath . $fileName, 'w');
fwrite($file, $response);
fclose($file);
return true;
} | [
"public",
"function",
"download",
"(",
"$",
"mediaId",
",",
"$",
"type",
",",
"$",
"filePath",
",",
"$",
"fileName",
")",
"{",
"$",
"this",
"->",
"mediaId",
"=",
"$",
"mediaId",
";",
"$",
"this",
"->",
"mediaType",
"=",
"$",
"type",
";",
"$",
"this... | Download Media from CMS library.
@param int $mediaId The media ID to download
@param string $type The module type to download
@param string $filePath Path to the directory where files should be saved
@param string $fileName Name of the saved media file
@return boolean | [
"Download",
"Media",
"from",
"CMS",
"library",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L327-L348 |
45,231 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLibrary.php | XiboLibrary.getUsage | public function getUsage($mediaId)
{
$this->mediaId = $mediaId;
$this->getLogger()->info('Getting media usage report ' . $mediaId . ' for Displays');
$response = $this->doGet('/library/usage/' . $mediaId );
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | php | public function getUsage($mediaId)
{
$this->mediaId = $mediaId;
$this->getLogger()->info('Getting media usage report ' . $mediaId . ' for Displays');
$response = $this->doGet('/library/usage/' . $mediaId );
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | [
"public",
"function",
"getUsage",
"(",
"$",
"mediaId",
")",
"{",
"$",
"this",
"->",
"mediaId",
"=",
"$",
"mediaId",
";",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting media usage report '",
".",
"$",
"mediaId",
".",
"' for Displays... | Get Media Usage for Displays
@param int $mediaId Media ID
@return XiboLibrary | [
"Get",
"Media",
"Usage",
"for",
"Displays"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLibrary.php#L356-L365 |
45,232 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPermissions.php | XiboPermissions.getPermissions | public function getPermissions($entity, $objectId)
{
$this->getLogger()->info('Getting Permissions arrays for Entity ' . $entity . ' with ID ' . $objectId);
$response = $this->doGet('/user/permissions/' . $entity . '/' . $objectId);
$entries = [];
foreach ($response as $item) {
$entries[] = clone $this->hydrate($item);
}
return $entries;
} | php | public function getPermissions($entity, $objectId)
{
$this->getLogger()->info('Getting Permissions arrays for Entity ' . $entity . ' with ID ' . $objectId);
$response = $this->doGet('/user/permissions/' . $entity . '/' . $objectId);
$entries = [];
foreach ($response as $item) {
$entries[] = clone $this->hydrate($item);
}
return $entries;
} | [
"public",
"function",
"getPermissions",
"(",
"$",
"entity",
",",
"$",
"objectId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting Permissions arrays for Entity '",
".",
"$",
"entity",
".",
"' with ID '",
".",
"$",
"objectId",
... | Get permissions to specific entity.
@param string $entity The Name of the entity Campaign, DataSet, DayPart, DisplayGroup, Media, Notification, Page, Playlist, Region, Widget
@param int $objectId the ID of the object to return permissions for
@return XiboPermissions|array | [
"Get",
"permissions",
"to",
"specific",
"entity",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPermissions.php#L72-L83 |
45,233 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPermissions.php | XiboPermissions.setPermissions | public function setPermissions($entity, $objectId, $groupId, $view, $edit, $delete, $ownerId = null)
{
$this->getLogger()->info('Setting Permissions view ' . $view . ' edit ' . $edit . ' delete ' . $delete . ' for user group ID ' . $groupId . ' to Entity ' . $entity . ' with ID ' . $objectId);
$this->entity = $entity;
$this->objectId = $objectId;
$this->groupId = $groupId;
$this->view = $view;
$this->edit = $edit;
$this->delete = $delete;
$this->ownerId = $ownerId;
$response = $this->doPost('/user/permissions/' . $entity . '/' . $objectId, [
'groupIds' => [
$groupId => [
'view' => $view,
'edit' => $edit,
'delete' => $delete
]
],
'ownerId' => $ownerId
]);
return $this->hydrate($response);
} | php | public function setPermissions($entity, $objectId, $groupId, $view, $edit, $delete, $ownerId = null)
{
$this->getLogger()->info('Setting Permissions view ' . $view . ' edit ' . $edit . ' delete ' . $delete . ' for user group ID ' . $groupId . ' to Entity ' . $entity . ' with ID ' . $objectId);
$this->entity = $entity;
$this->objectId = $objectId;
$this->groupId = $groupId;
$this->view = $view;
$this->edit = $edit;
$this->delete = $delete;
$this->ownerId = $ownerId;
$response = $this->doPost('/user/permissions/' . $entity . '/' . $objectId, [
'groupIds' => [
$groupId => [
'view' => $view,
'edit' => $edit,
'delete' => $delete
]
],
'ownerId' => $ownerId
]);
return $this->hydrate($response);
} | [
"public",
"function",
"setPermissions",
"(",
"$",
"entity",
",",
"$",
"objectId",
",",
"$",
"groupId",
",",
"$",
"view",
",",
"$",
"edit",
",",
"$",
"delete",
",",
"$",
"ownerId",
"=",
"null",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->... | Set permissions to specific entity.
@param string $entity The Name of the entity Campaign, DataSet, DayPart, DisplayGroup, Media, Notification, Page, Playlist, Region, Widget
@param int $objectId the ID of the object to return permissions for
@param int $groupId The group ID to which the permissions should be set for
@param int $view A flag indicating whether view permission should be granted
@param int $edit A flag indicating whether edit permission should be granted
@param int $delete A flag indicating whether delete permission should be granted
@param int $ownerId Change the owner of this item. Leave empty to keep the current owner
@return XiboPermissions | [
"Set",
"permissions",
"to",
"specific",
"entity",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPermissions.php#L98-L122 |
45,234 | xibosignage/oauth2-xibo-cms | src/Entity/XiboHls.php | XiboHls.create | public function create($name, $useDuration, $duration, $uri, $mute, $transparency, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->useDuration = $useDuration;
$this->duration = $duration;
$this->uri = $uri;
$this->mute = $mute;
$this->transparency = $transparency;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating HLS widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/hls/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $useDuration, $duration, $uri, $mute, $transparency, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->useDuration = $useDuration;
$this->duration = $duration;
$this->uri = $uri;
$this->mute = $mute;
$this->transparency = $transparency;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating HLS widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/hls/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"useDuration",
",",
"$",
"duration",
",",
"$",
"uri",
",",
"$",
"mute",
",",
"$",
"transparency",
",",
"$",
"playlistId",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"ge... | Create The HLS widget.
@param string $name Optional widget name
@param int $useDuration Flag indicating whether to use custom duration
@param int $duration Widget Duration
@param string $uri URL to HLS video stream
@param int $mute Flag Should the video be muted?
@param int $transparency Flag This causes some android devices to switch to a hardware accelerated web view
@param int $playlistId The playlist ID
@return XiboHls | [
"Create",
"The",
"HLS",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboHls.php#L76-L90 |
45,235 | xibosignage/oauth2-xibo-cms | src/Entity/XiboHls.php | XiboHls.edit | public function edit($name, $useDuration, $duration, $uri, $mute, $transparency, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->useDuration = $useDuration;
$this->duration = $duration;
$this->uri = $uri;
$this->mute = $mute;
$this->transparency = $transparency;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing HLS widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $useDuration, $duration, $uri, $mute, $transparency, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->useDuration = $useDuration;
$this->duration = $duration;
$this->uri = $uri;
$this->mute = $mute;
$this->transparency = $transparency;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing HLS widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"useDuration",
",",
"$",
"duration",
",",
"$",
"uri",
",",
"$",
"mute",
",",
"$",
"transparency",
",",
"$",
"widgetId",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEnt... | Edit the HLS widget.
@param string $name Optional widget name
@param int $useDuration Flag indicating whether to use custom duration
@param int $duration Widget Duration
@param string $uri URL to HLS video stream
@param int $mute Flag Should the video be muted?
@param int $transparency Flag This causes some android devices to switch to a hardware accelerated web view
@param int $widgetId the Widget ID
@return XiboHls | [
"Edit",
"the",
"HLS",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboHls.php#L104-L118 |
45,236 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPlaylist.php | XiboPlaylist.get | public function get(array $params = [])
{
$this->getLogger()->info('Getting list of Playlists');
if (isset($params['embed']))
$embed = ($params['embed'] != null) ? explode(',', $params['embed']) : [];
$hydratedWidgets = [];
$entries = [];
$response = $this->doGet('/playlist', $params);
foreach ($response as $item) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($item);
if (in_array('widgets', $embed) === true) {
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
}
$entries[] = clone $playlist;
}
return $entries;
} | php | public function get(array $params = [])
{
$this->getLogger()->info('Getting list of Playlists');
if (isset($params['embed']))
$embed = ($params['embed'] != null) ? explode(',', $params['embed']) : [];
$hydratedWidgets = [];
$entries = [];
$response = $this->doGet('/playlist', $params);
foreach ($response as $item) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($item);
if (in_array('widgets', $embed) === true) {
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
}
$entries[] = clone $playlist;
}
return $entries;
} | [
"public",
"function",
"get",
"(",
"array",
"$",
"params",
"=",
"[",
"]",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting list of Playlists'",
")",
";",
"if",
"(",
"isset",
"(",
"$",
"params",
"[",
"'embed'",
"]",
")",... | Return a list of playlists.
@param array $params can be filtered by: playlistId, name, userId, tags, mediaLike, embeddable parameter embed=widgets
@return array|XiboPlaylist | [
"Return",
"a",
"list",
"of",
"playlists",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPlaylist.php#L85-L112 |
45,237 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPlaylist.php | XiboPlaylist.assign | public function assign($media, $duration, $playlistId)
{
$this->playlistId = $playlistId;
$this->media = $media;
$this->getLogger()->info('Assigning Media To Playlist ' . $this->playlistId);
$response = $this->doPost('/playlist/library/assign/' . $playlistId, [
'media' => $media,
'duration' => $duration
]);
// Parse response
// set properties
$this->playlistId = $response['playlistId'];
$this->getLogger()->debug('Creating child object Widgets and linking it to parent Playlist');
// Set widgets property (with XiboWidget objects)
foreach ($response['widgets'] as $widget) {
$this->widgets[] = (new XiboWidget($this->getEntityProvider()))->hydrate($widget);
}
return $this;
} | php | public function assign($media, $duration, $playlistId)
{
$this->playlistId = $playlistId;
$this->media = $media;
$this->getLogger()->info('Assigning Media To Playlist ' . $this->playlistId);
$response = $this->doPost('/playlist/library/assign/' . $playlistId, [
'media' => $media,
'duration' => $duration
]);
// Parse response
// set properties
$this->playlistId = $response['playlistId'];
$this->getLogger()->debug('Creating child object Widgets and linking it to parent Playlist');
// Set widgets property (with XiboWidget objects)
foreach ($response['widgets'] as $widget) {
$this->widgets[] = (new XiboWidget($this->getEntityProvider()))->hydrate($widget);
}
return $this;
} | [
"public",
"function",
"assign",
"(",
"$",
"media",
",",
"$",
"duration",
",",
"$",
"playlistId",
")",
"{",
"$",
"this",
"->",
"playlistId",
"=",
"$",
"playlistId",
";",
"$",
"this",
"->",
"media",
"=",
"$",
"media",
";",
"$",
"this",
"->",
"getLogger... | Assign media to playlist.
@param array[int] $media Array of Media IDs to assign
@param int $duration Optional duration for all Media in this assignment to use on the widget
@param int $playlistId The Playlist ID to assign to
@return XiboPlaylist | [
"Assign",
"media",
"to",
"playlist",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPlaylist.php#L122-L143 |
45,238 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPlaylist.php | XiboPlaylist.add | public function add($name, $tags= '', $isDynamic = 0, $filterMediaName = '', $filterMediaTags = '')
{
$hydratedWidgets = [];
$this->name = $name;
$this->tags = $tags;
$this->isDynamic = $isDynamic;
$this->filterMediaName = $filterMediaName;
$this->filterMediaTags = $filterMediaTags;
$this->getLogger()->info('Creating Playlist ' . $this->name);
$response = $this->doPost('/playlist', $this->toArray());
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($response);
if (isset($playlist->widgets)) {
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
}
return $playlist;
} | php | public function add($name, $tags= '', $isDynamic = 0, $filterMediaName = '', $filterMediaTags = '')
{
$hydratedWidgets = [];
$this->name = $name;
$this->tags = $tags;
$this->isDynamic = $isDynamic;
$this->filterMediaName = $filterMediaName;
$this->filterMediaTags = $filterMediaTags;
$this->getLogger()->info('Creating Playlist ' . $this->name);
$response = $this->doPost('/playlist', $this->toArray());
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($response);
if (isset($playlist->widgets)) {
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
}
return $playlist;
} | [
"public",
"function",
"add",
"(",
"$",
"name",
",",
"$",
"tags",
"=",
"''",
",",
"$",
"isDynamic",
"=",
"0",
",",
"$",
"filterMediaName",
"=",
"''",
",",
"$",
"filterMediaTags",
"=",
"''",
")",
"{",
"$",
"hydratedWidgets",
"=",
"[",
"]",
";",
"$",
... | Create a new Playlist
@param string $name Name of the playlist
@param string $tags A Comma separated list of tags
@param int $isDynamic Flag indicating whether the playlist is dynamic
@param string $filterMediaName For dynamic playlist the filter by media Name
@param string $filterMediaTags For dynamic playlist the filter by media Tag
@return XiboPlaylist | [
"Create",
"a",
"new",
"Playlist"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPlaylist.php#L155-L181 |
45,239 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.create | public function create($displayGroup, $description, $isDynamic, $dynamicCriteria)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->displayGroup = $displayGroup;
$this->description = $description;
$this->isDynamic = $isDynamic;
$this->dynamicCriteria = $dynamicCriteria;
$this->getLogger()->info('Creating a new display Group ' . $displayGroup);
$response = $this->doPost('/displaygroup', $this->toArray());
return $this->hydrate($response);
} | php | public function create($displayGroup, $description, $isDynamic, $dynamicCriteria)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->displayGroup = $displayGroup;
$this->description = $description;
$this->isDynamic = $isDynamic;
$this->dynamicCriteria = $dynamicCriteria;
$this->getLogger()->info('Creating a new display Group ' . $displayGroup);
$response = $this->doPost('/displaygroup', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"displayGroup",
",",
"$",
"description",
",",
"$",
"isDynamic",
",",
"$",
"dynamicCriteria",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
"->",
"getMe",
"(",
")",
... | Create Display Group.
@param string $displayGroup The display group name
@param string $description The display group description
@param int $isDynamic Flag indicating whether this Display Group is dynamic
@param string $dynamicCriteria The filter criteria for this dynamic group. A comma separated set of regular expressions to apply
@return XiboDisplayGroup | [
"Create",
"Display",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L108-L120 |
45,240 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.delete | public function delete()
{
$this->getLogger()->info('Deleting Display Group ID ' . $this->displayGroupId);
$this->doDelete('/displaygroup/' . $this->displayGroupId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting Display Group ID ' . $this->displayGroupId);
$this->doDelete('/displaygroup/' . $this->displayGroupId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting Display Group ID '",
".",
"$",
"this",
"->",
"displayGroupId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/displaygroup/'",
".",
"$"... | Delete the display group.
@return bool | [
"Delete",
"the",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L148-L154 |
45,241 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.assignDisplay | public function assignDisplay($displayId)
{
$this->getLogger()->info('Assigning display ID ' . json_encode($displayId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/display/assign', [
'displayId' => $displayId
]);
return $this;
} | php | public function assignDisplay($displayId)
{
$this->getLogger()->info('Assigning display ID ' . json_encode($displayId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/display/assign', [
'displayId' => $displayId
]);
return $this;
} | [
"public",
"function",
"assignDisplay",
"(",
"$",
"displayId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Assigning display ID '",
".",
"json_encode",
"(",
"$",
"displayId",
")",
".",
"' To display Group ID '",
".",
"$",
"this",
... | Assign display to the display group.
@param array|int $displayId Display ID to assign
@return XiboDisplayGroup | [
"Assign",
"display",
"to",
"the",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L162-L170 |
45,242 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.unassignDisplay | public function unassignDisplay($displayId)
{
$this->getLogger()->info('Unassigning display ID ' . json_encode($displayId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/display/unassign', [
'displayId' => $displayId
]);
return $this;
} | php | public function unassignDisplay($displayId)
{
$this->getLogger()->info('Unassigning display ID ' . json_encode($displayId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/display/unassign', [
'displayId' => $displayId
]);
return $this;
} | [
"public",
"function",
"unassignDisplay",
"(",
"$",
"displayId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Unassigning display ID '",
".",
"json_encode",
"(",
"$",
"displayId",
")",
".",
"' From display Group ID '",
".",
"$",
"thi... | Unassign display from display group.
@param array|int $displayId The Display ID to unassign
@return XiboDisplayGroup | [
"Unassign",
"display",
"from",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L178-L186 |
45,243 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.assignDisplayGroup | public function assignDisplayGroup($displayGroupId)
{
$this->getLogger()->info('Assigning display Group ID ' . json_encode($displayGroupId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/displayGroup/assign', [
'displayGroupId' => $displayGroupId
]);
return $this;
} | php | public function assignDisplayGroup($displayGroupId)
{
$this->getLogger()->info('Assigning display Group ID ' . json_encode($displayGroupId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/displayGroup/assign', [
'displayGroupId' => $displayGroupId
]);
return $this;
} | [
"public",
"function",
"assignDisplayGroup",
"(",
"$",
"displayGroupId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Assigning display Group ID '",
".",
"json_encode",
"(",
"$",
"displayGroupId",
")",
".",
"' To display Group ID '",
"."... | Assign display group to a display group.
@param array|int $displayGroupId The Display Group ID to assign
@return XiboDisplayGroup | [
"Assign",
"display",
"group",
"to",
"a",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L194-L201 |
45,244 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.unassignDisplayGroup | public function unassignDisplayGroup($displayGroupId)
{
$this->getLogger()->info('Unassigning display Group ID ' . json_encode($displayGroupId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/displayGroup/unassign', [
'displayGroupId' => $displayGroupId
]);
return $this;
} | php | public function unassignDisplayGroup($displayGroupId)
{
$this->getLogger()->info('Unassigning display Group ID ' . json_encode($displayGroupId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/displayGroup/unassign', [
'displayGroupId' => $displayGroupId
]);
return $this;
} | [
"public",
"function",
"unassignDisplayGroup",
"(",
"$",
"displayGroupId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Unassigning display Group ID '",
".",
"json_encode",
"(",
"$",
"displayGroupId",
")",
".",
"' From display Group ID '",... | Unassign display group from display group.
@param array|int $displayGroupId The Display Group ID to unassign
@return XiboDisplayGroup | [
"Unassign",
"display",
"group",
"from",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L209-L216 |
45,245 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.assignLayout | public function assignLayout($layoutId)
{
$this->getLogger()->info('Assigning Layout ID ' . json_encode($layoutId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/layout/assign', [
'layoutId' => $layoutId
]);
return $this;
} | php | public function assignLayout($layoutId)
{
$this->getLogger()->info('Assigning Layout ID ' . json_encode($layoutId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/layout/assign', [
'layoutId' => $layoutId
]);
return $this;
} | [
"public",
"function",
"assignLayout",
"(",
"$",
"layoutId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Assigning Layout ID '",
".",
"json_encode",
"(",
"$",
"layoutId",
")",
".",
"' To display Group ID '",
".",
"$",
"this",
"->"... | Assign layout to display Group.
@param array|int $layoutId The Layout ID to assign
@return XiboDisplayGroup | [
"Assign",
"layout",
"to",
"display",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L224-L232 |
45,246 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.unassignLayout | public function unassignLayout($layoutId)
{
$this->getLogger()->info('Unassigning Layout ID ' . json_encode($layoutId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/layout/unassign', [
'layoutId' => $layoutId
]);
return $this;
} | php | public function unassignLayout($layoutId)
{
$this->getLogger()->info('Unassigning Layout ID ' . json_encode($layoutId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/layout/unassign', [
'layoutId' => $layoutId
]);
return $this;
} | [
"public",
"function",
"unassignLayout",
"(",
"$",
"layoutId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Unassigning Layout ID '",
".",
"json_encode",
"(",
"$",
"layoutId",
")",
".",
"' From display Group ID '",
".",
"$",
"this",
... | Unassign layout from display group.
@param array|int $layoutId The Layout ID to unassign
@return XiboDisplayGroup | [
"Unassign",
"layout",
"from",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L240-L248 |
45,247 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.assignMedia | public function assignMedia($mediaId)
{
$this->getLogger()->info('Assigning media ID ' . json_encode($mediaId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/media/assign', [
'mediaId' => $mediaId
]);
return $this;
} | php | public function assignMedia($mediaId)
{
$this->getLogger()->info('Assigning media ID ' . json_encode($mediaId) . ' To display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/media/assign', [
'mediaId' => $mediaId
]);
return $this;
} | [
"public",
"function",
"assignMedia",
"(",
"$",
"mediaId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Assigning media ID '",
".",
"json_encode",
"(",
"$",
"mediaId",
")",
".",
"' To display Group ID '",
".",
"$",
"this",
"->",
... | Assign media to display group.
@param array|int $mediaId Media ID to assign
@return XiboDisplayGroup | [
"Assign",
"media",
"to",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L256-L264 |
45,248 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.unassignMedia | public function unassignMedia($mediaId)
{
$this->getLogger()->info('Unassigning media ID ' . json_encode($mediaId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/media/unassign', [
'mediaId' => $mediaId
]);
return $this;
} | php | public function unassignMedia($mediaId)
{
$this->getLogger()->info('Unassigning media ID ' . json_encode($mediaId) . ' From display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/media/unassign', [
'mediaId' => $mediaId
]);
return $this;
} | [
"public",
"function",
"unassignMedia",
"(",
"$",
"mediaId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Unassigning media ID '",
".",
"json_encode",
"(",
"$",
"mediaId",
")",
".",
"' From display Group ID '",
".",
"$",
"this",
"-... | Unassign media from display group.
@param array|int $mediaId Media ID to unassign
@return XiboDisplayGroup | [
"Unassign",
"media",
"from",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L272-L280 |
45,249 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.collectNow | public function collectNow()
{
$this->getLogger()->info('Sending Collect Now action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/collectNow');
return $this;
} | php | public function collectNow()
{
$this->getLogger()->info('Sending Collect Now action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/collectNow');
return $this;
} | [
"public",
"function",
"collectNow",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending Collect Now action to display Group ID '",
".",
"$",
"this",
"->",
"displayGroupId",
")",
";",
"$",
"this",
"->",
"doPost",
"(",
"'/displa... | Collect Now.
Issue a CollectNow action to the displayGroup | [
"Collect",
"Now",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L287-L293 |
45,250 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.clear | public function clear()
{
$this->getLogger()->info('Sending Clear All stats and logs action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/clearStatsAndLogs');
return $this;
} | php | public function clear()
{
$this->getLogger()->info('Sending Clear All stats and logs action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/clearStatsAndLogs');
return $this;
} | [
"public",
"function",
"clear",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending Clear All stats and logs action to display Group ID '",
".",
"$",
"this",
"->",
"displayGroupId",
")",
";",
"$",
"this",
"->",
"doPost",
"(",
"... | Clear Stats and logs.
Issue a clearStatsAndLogs action to the displayGroup | [
"Clear",
"Stats",
"and",
"logs",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L300-L306 |
45,251 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.revertToSchedule | public function revertToSchedule()
{
$this->getLogger()->info('Sending Revert to Schedule action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/revertToSchedule');
return $this;
} | php | public function revertToSchedule()
{
$this->getLogger()->info('Sending Revert to Schedule action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/revertToSchedule');
return $this;
} | [
"public",
"function",
"revertToSchedule",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending Revert to Schedule action to display Group ID '",
".",
"$",
"this",
"->",
"displayGroupId",
")",
";",
"$",
"this",
"->",
"doPost",
"("... | Revert to Schedule.
Issue revertToSchedule action to the display Group | [
"Revert",
"to",
"Schedule",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L336-L342 |
45,252 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.overlayLayout | public function overlayLayout($layoutId, $duration, $downloadRequired)
{
$this->getLogger()->info('Sending Overlay Layout action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/overlayLayout', [
'layoutId' => $layoutId,
'duration' => $duration,
'downloadRequired' => $downloadRequired
]);
return $this;
} | php | public function overlayLayout($layoutId, $duration, $downloadRequired)
{
$this->getLogger()->info('Sending Overlay Layout action to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/overlayLayout', [
'layoutId' => $layoutId,
'duration' => $duration,
'downloadRequired' => $downloadRequired
]);
return $this;
} | [
"public",
"function",
"overlayLayout",
"(",
"$",
"layoutId",
",",
"$",
"duration",
",",
"$",
"downloadRequired",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending Overlay Layout action to display Group ID '",
".",
"$",
"this",
"->"... | Overlay Layout.
Issue overLayout action to the display group
@param int $layoutId Layout ID
@param int $duration Duration in seconds for this layout change to remain in effect
@param int $downloadRequired Flag indicating whether the player should perform a collect before playing the layout
@return XiboDisplayGroup | [
"Overlay",
"Layout",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L354-L364 |
45,253 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplayGroup.php | XiboDisplayGroup.command | public function command($commandId)
{
$this->getLogger()->info('Sending predefined Command to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/command', [
'commandId' => $commandId,
]);
return $this;
} | php | public function command($commandId)
{
$this->getLogger()->info('Sending predefined Command to display Group ID ' . $this->displayGroupId);
$this->doPost('/displaygroup/' . $this->displayGroupId . '/action/command', [
'commandId' => $commandId,
]);
return $this;
} | [
"public",
"function",
"command",
"(",
"$",
"commandId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending predefined Command to display Group ID '",
".",
"$",
"this",
"->",
"displayGroupId",
")",
";",
"$",
"this",
"->",
"doPost",... | Send a command to the display group.
@param int $commandId The Command ID
@return XiboDisplayGroup | [
"Send",
"a",
"command",
"to",
"the",
"display",
"group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplayGroup.php#L372-L380 |
45,254 | xibosignage/oauth2-xibo-cms | src/Entity/XiboText.php | XiboText.create | public function create($name, $duration, $useDuration, $effect, $speed, $backgroundColor, $marqueeInlineSelector, $text, $javaScript, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->marqueeInlineSelector = $marqueeInlineSelector;
$this->text = $text;
$this->javaScript = $javaScript;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating a new Text widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/text/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $effect, $speed, $backgroundColor, $marqueeInlineSelector, $text, $javaScript, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->marqueeInlineSelector = $marqueeInlineSelector;
$this->text = $text;
$this->javaScript = $javaScript;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating a new Text widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/text/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"backgroundColor",
",",
"$",
"marqueeInlineSelector",
",",
"$",
"text",
",",
"$",
"javaScript",
",",
"$",
... | Create new Text Widget.
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)
@param string $backgroundColor A HEX color to use as the background color of this widget
@param string $marqueeInlineSelector The selector to use for stacking marquee items in a line when scrolling left/right
@param string $text The Text to display in the widget
@param string $javaScript Optional JavaScript
@param int $playlistId Playlist ID
@return XiboText | [
"Create",
"new",
"Text",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboText.php#L88-L105 |
45,255 | xibosignage/oauth2-xibo-cms | src/Entity/XiboText.php | XiboText.edit | public function edit($name, $duration, $useDuration, $effect, $speed, $backgroundColor, $marqueeInlineSelector, $text, $javaScript, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->marqueeInlineSelector = $marqueeInlineSelector;
$this->text = $text;
$this->javaScript = $javaScript;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $effect, $speed, $backgroundColor, $marqueeInlineSelector, $text, $javaScript, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->marqueeInlineSelector = $marqueeInlineSelector;
$this->text = $text;
$this->javaScript = $javaScript;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"backgroundColor",
",",
"$",
"marqueeInlineSelector",
",",
"$",
"text",
",",
"$",
"javaScript",
",",
"$",
"w... | Edit existing Text Widget.
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)
@param string $backgroundColor A HEX color to use as the background color of this widget
@param string $marqueeInlineSelector The selector to use for stacking marquee items in a line when scrolling left/right
@param string $text The Text to display in the widget
@param string $javaScript Optional JavaScript
@param int $widgetId the Widget ID
@return XiboText | [
"Edit",
"existing",
"Text",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboText.php#L122-L139 |
45,256 | xibosignage/oauth2-xibo-cms | src/Entity/XiboSchedule.php | XiboSchedule.getEvents | public function getEvents($displayGroupId, $date)
{
$this->getLogger()->info('Getting list of events for specified display group ' . $displayGroupId . ' and date ' . $date);
$response = $this->doGet('/schedule/' . $displayGroupId . '/events', [
'date' => $date
]);
return clone $this->hydrate($response);
} | php | public function getEvents($displayGroupId, $date)
{
$this->getLogger()->info('Getting list of events for specified display group ' . $displayGroupId . ' and date ' . $date);
$response = $this->doGet('/schedule/' . $displayGroupId . '/events', [
'date' => $date
]);
return clone $this->hydrate($response);
} | [
"public",
"function",
"getEvents",
"(",
"$",
"displayGroupId",
",",
"$",
"date",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting list of events for specified display group '",
".",
"$",
"displayGroupId",
".",
"' and date '",
".",
... | Get events for specified display Group ID.
@param int $displayGroupId The display group ID
@param string $date Date in Y-m-d H:i:s
@return array|XiboSchedule | [
"Get",
"events",
"for",
"specified",
"display",
"Group",
"ID",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboSchedule.php#L110-L118 |
45,257 | xibosignage/oauth2-xibo-cms | src/Entity/XiboSchedule.php | XiboSchedule.getById | public function getById(array $params = [], $id)
{
$this->getLogger()->info('Getting event with ID ' . $id);
$entries = [];
# need at least display group (always events) and to, from (other dayparts)
$response = $this->doGet('/schedule/data/events', $params);
foreach ($response['result'] as $item) {
if($item['id'] === $id){
$entries[] = clone $this->hydrate($item);
}
else
throw new XiboApiException('Provided eventId not found ' . $id);
}
return $entries;
} | php | public function getById(array $params = [], $id)
{
$this->getLogger()->info('Getting event with ID ' . $id);
$entries = [];
# need at least display group (always events) and to, from (other dayparts)
$response = $this->doGet('/schedule/data/events', $params);
foreach ($response['result'] as $item) {
if($item['id'] === $id){
$entries[] = clone $this->hydrate($item);
}
else
throw new XiboApiException('Provided eventId not found ' . $id);
}
return $entries;
} | [
"public",
"function",
"getById",
"(",
"array",
"$",
"params",
"=",
"[",
"]",
",",
"$",
"id",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting event with ID '",
".",
"$",
"id",
")",
";",
"$",
"entries",
"=",
"[",
"]",... | Get a list of scheduled events for the specified display Group.
@param array $params
@param int $id The Event ID
@return array $entries require displayGroupId additionally to and from can be added for dayparts other than always
@throws XiboApiException | [
"Get",
"a",
"list",
"of",
"scheduled",
"events",
"for",
"the",
"specified",
"display",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboSchedule.php#L128-L143 |
45,258 | xibosignage/oauth2-xibo-cms | src/Entity/XiboSchedule.php | XiboSchedule.createEventCommand | public function createEventCommand($fromDt, $commandId, $displayGroupIds, $recurrenceType, $recurrenceDetail, $recurrenceRange, $displayOrder, $isPriority, $syncTimezone)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->eventTypeId = 2;
$this->fromDt = $fromDt;
$this->commandId = $commandId;
$this->displayGroupIds = $displayGroupIds;
$this->recurrenceType = $recurrenceType;
$this->recurrenceDetail = $recurrenceDetail;
$this->recurrenceRange = $recurrenceRange;
$this->displayOrder = $displayOrder;
$this->isPriority = $isPriority;
$this->syncTimezone = $syncTimezone;
$this->getLogger()->info('Creating new scheduled command ');
$response = $this->doPost('/schedule', $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate ');
return $this->hydrate($response);
} | php | public function createEventCommand($fromDt, $commandId, $displayGroupIds, $recurrenceType, $recurrenceDetail, $recurrenceRange, $displayOrder, $isPriority, $syncTimezone)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->eventTypeId = 2;
$this->fromDt = $fromDt;
$this->commandId = $commandId;
$this->displayGroupIds = $displayGroupIds;
$this->recurrenceType = $recurrenceType;
$this->recurrenceDetail = $recurrenceDetail;
$this->recurrenceRange = $recurrenceRange;
$this->displayOrder = $displayOrder;
$this->isPriority = $isPriority;
$this->syncTimezone = $syncTimezone;
$this->getLogger()->info('Creating new scheduled command ');
$response = $this->doPost('/schedule', $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate ');
return $this->hydrate($response);
} | [
"public",
"function",
"createEventCommand",
"(",
"$",
"fromDt",
",",
"$",
"commandId",
",",
"$",
"displayGroupIds",
",",
"$",
"recurrenceType",
",",
"$",
"recurrenceDetail",
",",
"$",
"recurrenceRange",
",",
"$",
"displayOrder",
",",
"$",
"isPriority",
",",
"$... | Create Command event.
@param string $fromDt the FROM date for this event
@param int $commandId The Command ID to use for this Event
@param array[int] $displayGroupIds Array of display Group IDs for this event, Display specific Display Group IDs should be used to schedule on single displays.
@param string $recurrenceType The type of recurrence to apply to this event, Available values : , Minute, Hour, Day, Week, Month, Year
@param int $recurrenceDetail The interval for the recurrence
@param string $recurrenceRange The end date for this events recurrence
@param int $displayOrder The display order for this event.
@param int $isPriority An integer indicating the priority of this event. Normal events have a priority of 0
@param int $syncTimezone Flag Should this schedule be synced to the resulting Display timezone
@return XiboSchedule | [
"Create",
"Command",
"event",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboSchedule.php#L198-L217 |
45,259 | xibosignage/oauth2-xibo-cms | src/Entity/XiboSchedule.php | XiboSchedule.delete | public function delete()
{
$this->getLogger()->info('Deleting scheduled event ID ' . $this->eventId);
$this->doDelete('/schedule/' . $this->eventId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting scheduled event ID ' . $this->eventId);
$this->doDelete('/schedule/' . $this->eventId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting scheduled event ID '",
".",
"$",
"this",
"->",
"eventId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/schedule/'",
".",
"$",
"this... | Delete the scheduled event.
@return bool | [
"Delete",
"the",
"scheduled",
"event",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboSchedule.php#L305-L311 |
45,260 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCommand.php | XiboCommand.create | public function create($name, $description, $code)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->command = $name;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Creating new display command ' . $name);
$response = $this->doPost('/command', $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $description, $code)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->command = $name;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Creating new display command ' . $name);
$response = $this->doPost('/command', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"code",
")",
"{",
"$",
"this",
"->",
"userId",
"=",
"$",
"this",
"->",
"getEntityProvider",
"(",
")",
"->",
"getMe",
"(",
")",
"->",
"getId",
"(",
")",
";",
"$",
... | Create a new command.
@param string $name Name of the command
@param string $description Command description
@param string $code Unique code for this command
@return XiboCommand | [
"Create",
"a",
"new",
"command",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCommand.php#L92-L102 |
45,261 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCommand.php | XiboCommand.edit | public function edit($name, $description, $code)
{
$this->command = $name;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Editing display command ID ' . $this->commandId);
$response = $this->doPut('/command/' . $this->commandId, $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $description, $code)
{
$this->command = $name;
$this->description = $description;
$this->code = $code;
$this->getLogger()->info('Editing display command ID ' . $this->commandId);
$response = $this->doPut('/command/' . $this->commandId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"code",
")",
"{",
"$",
"this",
"->",
"command",
"=",
"$",
"name",
";",
"$",
"this",
"->",
"description",
"=",
"$",
"description",
";",
"$",
"this",
"->",
"code",
"="... | Edit the Command.
@param string $name Name of the command
@param string $description Command description
@param string $code Unique code for this command
@return XiboCommand | [
"Edit",
"the",
"Command",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCommand.php#L113-L122 |
45,262 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCommand.php | XiboCommand.delete | public function delete()
{
$this->getLogger()->info('Deleting display command ID ' . $this->commandId);
$this->doDelete('/command/' . $this->commandId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting display command ID ' . $this->commandId);
$this->doDelete('/command/' . $this->commandId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting display command ID '",
".",
"$",
"this",
"->",
"commandId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/command/'",
".",
"$",
"thi... | Delete the command.
@return bool | [
"Delete",
"the",
"command",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCommand.php#L129-L135 |
45,263 | xibosignage/oauth2-xibo-cms | src/Entity/XiboClock.php | XiboClock.create | public function create($name, $duration, $useDuration, $themeId, $clockTypeId, $offset, $format, $showSeconds, $clockFace, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->themeId = $themeId;
$this->clockTypeId = $clockTypeId;
$this->offset = $offset;
$this->format = $format;
$this->showSeconds = $showSeconds;
$this->clockFace = $clockFace;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Clock widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/clock/' . $playlistId, $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $themeId, $clockTypeId, $offset, $format, $showSeconds, $clockFace, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->themeId = $themeId;
$this->clockTypeId = $clockTypeId;
$this->offset = $offset;
$this->format = $format;
$this->showSeconds = $showSeconds;
$this->clockFace = $clockFace;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Clock widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/clock/' . $playlistId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"themeId",
",",
"$",
"clockTypeId",
",",
"$",
"offset",
",",
"$",
"format",
",",
"$",
"showSeconds",
",",
"$",
"clockFace",
",",
"$",
"playlistId... | Create a new Clock Widget.
@param string $name widget name
@param int $duration widget duration
@param int $useDuration flag (0, 1) set to 1 if the duration parameter is passed as well
@param int $themeId For Analogue clock, light and dark themes
@param int $clockTypeId Type of the clock 1- Analogue, 2- Digital, 3- Flip Clock
@param string $offset The offset in minutes that should be applied to the current time, if a counter is selected then date/time to run from in format Y-m-d H:i:s
@param string $format For digital clock, format in which the time should be displayed
@param int $showSeconds For Flip Clock, should the clock show seconds or not
@param string $clockFace For Flip Clock, supported options are: TwelveHourClock, TwentyFourHourClock, DailyCounter, HourlyCounter, MinuteCounter
@param int $playlistId Playlist ID to which the clock widget should be added
@return XiboClock | [
"Create",
"a",
"new",
"Clock",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboClock.php#L91-L108 |
45,264 | xibosignage/oauth2-xibo-cms | src/Entity/XiboClock.php | XiboClock.edit | public function edit($name, $duration, $useDuration, $themeId, $clockTypeId, $offset, $format, $showSeconds, $clockFace, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->themeId = $themeId;
$this->clockTypeId = $clockTypeId;
$this->offset = $offset;
$this->format = $format;
$this->showSeconds = $showSeconds;
$this->clockFace = $clockFace;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $themeId, $clockTypeId, $offset, $format, $showSeconds, $clockFace, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->themeId = $themeId;
$this->clockTypeId = $clockTypeId;
$this->offset = $offset;
$this->format = $format;
$this->showSeconds = $showSeconds;
$this->clockFace = $clockFace;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"themeId",
",",
"$",
"clockTypeId",
",",
"$",
"offset",
",",
"$",
"format",
",",
"$",
"showSeconds",
",",
"$",
"clockFace",
",",
"$",
"widgetId",
... | Edit the Clock widget.
@param string $name widget name
@param int $duration widget duration
@param int $useDuration flag (0, 1) set to 1 if the duration parameter is passed as well
@param int $themeId For Analogue clock, light and dark themes
@param int $clockTypeId Type of the clock 1- Analogue, 2- Digital, 3- Flip Clock
@param string $offset The offset in minutes that should be applied to the current time, if a counter is selected then date/time to run from in format Y-m-d H:i:s
@param string $format For digital clock, format in which the time should be displayed
@param int $showSeconds For Flip Clock, should the clock show seconds or not
@param string $clockFace For Flip Clock, supported options are: TwelveHourClock, TwentyFourHourClock, DailyCounter, HourlyCounter, MinuteCounter
@param int $widgetId Widget Id to Edit
@return XiboClock | [
"Edit",
"the",
"Clock",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboClock.php#L125-L142 |
45,265 | xibosignage/oauth2-xibo-cms | src/Entity/XiboCurrencies.php | XiboCurrencies.create | public function create($templateId, $name, $duration, $useDuration, $base, $items, $reverseConversion, $effect, $speed, $backgroundColor, $noRecordsMessage, $dateFormat, $updateInterval, $durationIsPerPage, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->overrideTemplate = 0;
$this->templateId = $templateId;
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->base = $base;
$this->items = $items;
$this->reverseConversion = $reverseConversion;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->noRecordsMessage = $noRecordsMessage;
$this->dateFormat = $dateFormat;
$this->updateInterval = $updateInterval;
$this->durationIsPerPage = $durationIsPerPage;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Currencies widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/currencies/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($templateId, $name, $duration, $useDuration, $base, $items, $reverseConversion, $effect, $speed, $backgroundColor, $noRecordsMessage, $dateFormat, $updateInterval, $durationIsPerPage, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->overrideTemplate = 0;
$this->templateId = $templateId;
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->base = $base;
$this->items = $items;
$this->reverseConversion = $reverseConversion;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->noRecordsMessage = $noRecordsMessage;
$this->dateFormat = $dateFormat;
$this->updateInterval = $updateInterval;
$this->durationIsPerPage = $durationIsPerPage;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Currencies widget and assigning it to playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/currencies/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"templateId",
",",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"base",
",",
"$",
"items",
",",
"$",
"reverseConversion",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"backgroundCol... | Create Currencies Widget.
@param string $templateId The template ID, currencies1, currencies2
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag Select 1 only if you will provide duration parameter as well
@param string $base The base currency
@param string $items The comma separated string of wanted items
@param int $reverseConversion Flag Select 1 if you’d like your base currency to be used as the comparison currency you’ve entered
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal)
@param string $backgroundColor A HEX color to use as the background color of this widget
@param string $noRecordsMessage A message to display when there are no records returned by the search query
@param string $dateFormat The format to apply to all dates returned by he widget
@param int $updateInterval Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60
@param int $durationIsPerPage Flag The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items
@param int $playlistId The Playlist ID
@return XiboCurrencies | [
"Create",
"Currencies",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboCurrencies.php#L133-L157 |
45,266 | xibosignage/oauth2-xibo-cms | src/Entity/XiboEntity.php | XiboEntity.hydrate | public function hydrate(array $properties, $options = [])
{
$this->getLogger()->debug('Hydrating the response');
$intProperties = (array_key_exists('intProperties', $options)) ? $options['intProperties'] : [];
$stringProperties = (array_key_exists('stringProperties', $options)) ? $options['stringProperties'] : [];
$htmlStringProperties = (array_key_exists('htmlStringProperties', $options)) ? $options['htmlStringProperties'] : [];
foreach ($properties as $prop => $val) {
if (property_exists($this, $prop)) {
if (stripos(strrev($prop), 'dI') === 0 || in_array($prop, $intProperties))
$val = intval($val);
else if (in_array($prop, $stringProperties))
$val = filter_var($val, FILTER_SANITIZE_STRING);
else if (in_array($prop, $htmlStringProperties))
$val = htmlentities($val);
$this->{$prop} = $val;
}
}
return $this;
} | php | public function hydrate(array $properties, $options = [])
{
$this->getLogger()->debug('Hydrating the response');
$intProperties = (array_key_exists('intProperties', $options)) ? $options['intProperties'] : [];
$stringProperties = (array_key_exists('stringProperties', $options)) ? $options['stringProperties'] : [];
$htmlStringProperties = (array_key_exists('htmlStringProperties', $options)) ? $options['htmlStringProperties'] : [];
foreach ($properties as $prop => $val) {
if (property_exists($this, $prop)) {
if (stripos(strrev($prop), 'dI') === 0 || in_array($prop, $intProperties))
$val = intval($val);
else if (in_array($prop, $stringProperties))
$val = filter_var($val, FILTER_SANITIZE_STRING);
else if (in_array($prop, $htmlStringProperties))
$val = htmlentities($val);
$this->{$prop} = $val;
}
}
return $this;
} | [
"public",
"function",
"hydrate",
"(",
"array",
"$",
"properties",
",",
"$",
"options",
"=",
"[",
"]",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"debug",
"(",
"'Hydrating the response'",
")",
";",
"$",
"intProperties",
"=",
"(",
"array_key... | Hydrate an entity with properties
@param array $properties
@param array $options
@return self | [
"Hydrate",
"an",
"entity",
"with",
"properties"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboEntity.php#L52-L74 |
45,267 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUserGroup.php | XiboUserGroup.create | public function create($group, $libraryQuota = 0, $isSystemNotification = 0, $isDisplayNotification = 0)
{
$this->group = $group;
$this->libraryQuota = $libraryQuota;
$this->isSystemNotification = $isSystemNotification;
$this->isDisplayNotification = $isDisplayNotification;
$this->getLogger()->info('Creating User Group ' . $this->group);
$response = $this->doPost('/group', $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | php | public function create($group, $libraryQuota = 0, $isSystemNotification = 0, $isDisplayNotification = 0)
{
$this->group = $group;
$this->libraryQuota = $libraryQuota;
$this->isSystemNotification = $isSystemNotification;
$this->isDisplayNotification = $isDisplayNotification;
$this->getLogger()->info('Creating User Group ' . $this->group);
$response = $this->doPost('/group', $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | [
"public",
"function",
"create",
"(",
"$",
"group",
",",
"$",
"libraryQuota",
"=",
"0",
",",
"$",
"isSystemNotification",
"=",
"0",
",",
"$",
"isDisplayNotification",
"=",
"0",
")",
"{",
"$",
"this",
"->",
"group",
"=",
"$",
"group",
";",
"$",
"this",
... | Create a new User Group.
@param string $group The Group Name
@param int $libraryQuota The User Group library quota in kilobytes
@param int $isSystemNotification Flag (0, 1), should members of this Group receive system notifications?
@param int $isDisplayNotification Flag (0, 1), should members of this Group receive Display notifications for Displays they have permissions to see
@return XiboUserGroup | [
"Create",
"a",
"new",
"User",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUserGroup.php#L117-L132 |
45,268 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUserGroup.php | XiboUserGroup.edit | public function edit($groupId, $group, $libraryQuota = 0, $isSystemNotification = 0, $isDisplayNotification = 0)
{
$this->groupId = $groupId;
$this->group = $group;
$this->libraryQuota = $libraryQuota;
$this->isSystemNotification = $isSystemNotification;
$this->isDisplayNotification = $isDisplayNotification;
$this->getLogger()->info('Editing User Group ID ' . $this->groupId);
$response = $this->doPut('/group/' . $groupId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | php | public function edit($groupId, $group, $libraryQuota = 0, $isSystemNotification = 0, $isDisplayNotification = 0)
{
$this->groupId = $groupId;
$this->group = $group;
$this->libraryQuota = $libraryQuota;
$this->isSystemNotification = $isSystemNotification;
$this->isDisplayNotification = $isDisplayNotification;
$this->getLogger()->info('Editing User Group ID ' . $this->groupId);
$response = $this->doPut('/group/' . $groupId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | [
"public",
"function",
"edit",
"(",
"$",
"groupId",
",",
"$",
"group",
",",
"$",
"libraryQuota",
"=",
"0",
",",
"$",
"isSystemNotification",
"=",
"0",
",",
"$",
"isDisplayNotification",
"=",
"0",
")",
"{",
"$",
"this",
"->",
"groupId",
"=",
"$",
"groupI... | Edit an existing User Group.
@param int $groupId The ID of the group to edit
@param string $group The Group Name
@param int $libraryQuota The User Group library quota in kilobytes
@param int $isSystemNotification Flag (0, 1), should members of this Group receive system notifications?
@param int $isDisplayNotification Flag (0, 1), should members of this Group receive Display notifications for Displays they have permissions to see
@return XiboUserGroup | [
"Edit",
"an",
"existing",
"User",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUserGroup.php#L144-L160 |
45,269 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUserGroup.php | XiboUserGroup.delete | public function delete()
{
$this->getLogger()->info('Deleting User Group ID ' . $this->groupId);
$this->doDelete('/group/' . $this->groupId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting User Group ID ' . $this->groupId);
$this->doDelete('/group/' . $this->groupId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting User Group ID '",
".",
"$",
"this",
"->",
"groupId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/group/'",
".",
"$",
"this",
"->... | Delete the User Group
@return bool | [
"Delete",
"the",
"User",
"Group"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUserGroup.php#L167-L173 |
45,270 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUserGroup.php | XiboUserGroup.assignUser | public function assignUser($userGroupId, $userId = [])
{
$this->groupId = $userGroupId;
$this->getLogger()->info('Assigning User IDs ' . json_encode($userId) . ' To User Group ID ' . $this->groupId);
$response = $this->doPost('/group/members/assign/' . $userGroupId, [
'userId' => $userId
]);
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | php | public function assignUser($userGroupId, $userId = [])
{
$this->groupId = $userGroupId;
$this->getLogger()->info('Assigning User IDs ' . json_encode($userId) . ' To User Group ID ' . $this->groupId);
$response = $this->doPost('/group/members/assign/' . $userGroupId, [
'userId' => $userId
]);
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | [
"public",
"function",
"assignUser",
"(",
"$",
"userGroupId",
",",
"$",
"userId",
"=",
"[",
"]",
")",
"{",
"$",
"this",
"->",
"groupId",
"=",
"$",
"userGroupId",
";",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Assigning User IDs '",
... | Assign User to a User Group.
@param int $userGroupId The ID of the user group
@param array|int $userId The ID of the user
@return XiboUserGroup | [
"Assign",
"User",
"to",
"a",
"User",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUserGroup.php#L183-L196 |
45,271 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUserGroup.php | XiboUserGroup.copy | public function copy($userGroupId, $group, $copyMembers = 0)
{
$this->groupId = $userGroupId;
$this->copyMembers = $copyMembers;
$this->getLogger()->info('Creating a copy of User Group ID ' . $userGroupId);
$response = $this->doPost('/group/' . $userGroupId . '/copy', [
'group' => $group,
'copyMembers' => $copyMembers
]);
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | php | public function copy($userGroupId, $group, $copyMembers = 0)
{
$this->groupId = $userGroupId;
$this->copyMembers = $copyMembers;
$this->getLogger()->info('Creating a copy of User Group ID ' . $userGroupId);
$response = $this->doPost('/group/' . $userGroupId . '/copy', [
'group' => $group,
'copyMembers' => $copyMembers
]);
/** @var XiboUserGroup $userGroup */
$userGroup = $this->hydrate($response);
return $userGroup;
} | [
"public",
"function",
"copy",
"(",
"$",
"userGroupId",
",",
"$",
"group",
",",
"$",
"copyMembers",
"=",
"0",
")",
"{",
"$",
"this",
"->",
"groupId",
"=",
"$",
"userGroupId",
";",
"$",
"this",
"->",
"copyMembers",
"=",
"$",
"copyMembers",
";",
"$",
"t... | Copy User Group.
@param int $userGroupId The ID of the user group
@param string $group Group Name
@param int $copyMembers Flag indicating whether to copy group members
@return XiboUserGroup | [
"Copy",
"User",
"Group",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUserGroup.php#L230-L245 |
45,272 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDaypart.php | XiboDaypart.create | public function create($name, $description, $startTime, $endTime, $exceptionDays = [], $exceptionStartTimes = [], $exceptionEndTimes = [])
{
$this->name = $name;
$this->description = $description;
$this->startTime = $startTime;
$this->endTime = $endTime;
$this->exceptionDays = $exceptionDays;
$this->exceptionStartTimes = $exceptionStartTimes;
$this->exceptionEndTimes = $exceptionEndTimes;
$this->getLogger()->info('Creating dayPart ' . $name);
$response = $this->doPost('/daypart', $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $description, $startTime, $endTime, $exceptionDays = [], $exceptionStartTimes = [], $exceptionEndTimes = [])
{
$this->name = $name;
$this->description = $description;
$this->startTime = $startTime;
$this->endTime = $endTime;
$this->exceptionDays = $exceptionDays;
$this->exceptionStartTimes = $exceptionStartTimes;
$this->exceptionEndTimes = $exceptionEndTimes;
$this->getLogger()->info('Creating dayPart ' . $name);
$response = $this->doPost('/daypart', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"startTime",
",",
"$",
"endTime",
",",
"$",
"exceptionDays",
"=",
"[",
"]",
",",
"$",
"exceptionStartTimes",
"=",
"[",
"]",
",",
"$",
"exceptionEndTimes",
"=",
"[",
"]... | Create a new DayPrt.
@param string $name The name for the daypart
@param string $description The description for the daypart
@param string $startTime The start time for this daypart
@param string $endTime The end time for this daypart
@param array[string] $exceptionDays String array of exception days
@param array[string] $exceptionStartTimes String array of start times to match the exception days
@param array[string] $exceptionEndTimes String array of end times to match the exception days
@return XiboDaypart | [
"Create",
"a",
"new",
"DayPrt",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDaypart.php#L108-L122 |
45,273 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDaypart.php | XiboDaypart.edit | public function edit($name, $description, $startTime, $endTime, $exceptionDays = [], $exceptionStartTimes = [], $exceptionEndTimes = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->description = $description;
$this->startTime = $startTime;
$this->endTime = $endTime;
$this->exceptionDays = $exceptionDays;
$this->exceptionStartTimes = $exceptionStartTimes;
$this->exceptionEndTimes = $exceptionEndTimes;
$this->getLogger()->info('Editing dayPart ID ' . $this->dayPartId);
$response = $this->doPut('/daypart/' . $this->dayPartId, $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $description, $startTime, $endTime, $exceptionDays = [], $exceptionStartTimes = [], $exceptionEndTimes = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->description = $description;
$this->startTime = $startTime;
$this->endTime = $endTime;
$this->exceptionDays = $exceptionDays;
$this->exceptionStartTimes = $exceptionStartTimes;
$this->exceptionEndTimes = $exceptionEndTimes;
$this->getLogger()->info('Editing dayPart ID ' . $this->dayPartId);
$response = $this->doPut('/daypart/' . $this->dayPartId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"startTime",
",",
"$",
"endTime",
",",
"$",
"exceptionDays",
"=",
"[",
"]",
",",
"$",
"exceptionStartTimes",
"=",
"[",
"]",
",",
"$",
"exceptionEndTimes",
"=",
"[",
"]",... | Edit Daypart.
@param string $name The name for the daypart
@param string $description The description for the daypart
@param string $startTime The start time for this daypart
@param string $endTime The end time for this daypart
@param array[string] $exceptionDays String array of exception days
@param array[string] $exceptionStartTimes String array of start times to match the exception days
@param array[string] $exceptionEndTimes String array of end times to match the exception days
@return XiboDaypart | [
"Edit",
"Daypart",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDaypart.php#L136-L151 |
45,274 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDaypart.php | XiboDaypart.delete | public function delete()
{
$this->getLogger()->info('Deleting dayPart ID ' . $this->dayPartId);
$this->doDelete('/daypart/' . $this->dayPartId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting dayPart ID ' . $this->dayPartId);
$this->doDelete('/daypart/' . $this->dayPartId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting dayPart ID '",
".",
"$",
"this",
"->",
"dayPartId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/daypart/'",
".",
"$",
"this",
"-... | Delete the daypart.
@return bool | [
"Delete",
"the",
"daypart",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDaypart.php#L158-L164 |
45,275 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUser.php | XiboUser.edit | public function edit($userId, $userName, $userTypeId, $homePageId, $newUserWizard, $hideNavigation, $newPassword = '', $retypeNewPassword = '', $email= '', $libraryQuota = 0, $isPasswordChangeRequired = 0, $firstName = '', $lastName = '', $phone = '', $ref1 = '', $ref2 = '', $ref3 = '', $ref4 = '', $ref5 = '')
{
$this->userId = $userId;
$this->userName = $userName;
$this->userTypeId = $userTypeId;
$this->homePageId = $homePageId;
$this->newPassword = $newPassword;
$this->retypeNewPassword = $retypeNewPassword;
$this->newUserWizard = $newUserWizard;
$this->hideNavigation = $hideNavigation;
$this->email = $email;
$this->libraryQuota = $libraryQuota;
$this->isPasswordChangeRequired = $isPasswordChangeRequired;
$this->firstName = $firstName;
$this->lastName = $lastName;
$this->phone = $phone;
$this->ref1 = $ref1;
$this->ref2 = $ref2;
$this->ref3 = $ref3;
$this->ref4 = $ref4;
$this->ref5 = $ref5;
$this->getLogger()->info('Editing User ID ' . $userId);
$response = $this->doPut('/user/' . $userId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUser $user */
$user = $this->hydrate($response);
return $user;
} | php | public function edit($userId, $userName, $userTypeId, $homePageId, $newUserWizard, $hideNavigation, $newPassword = '', $retypeNewPassword = '', $email= '', $libraryQuota = 0, $isPasswordChangeRequired = 0, $firstName = '', $lastName = '', $phone = '', $ref1 = '', $ref2 = '', $ref3 = '', $ref4 = '', $ref5 = '')
{
$this->userId = $userId;
$this->userName = $userName;
$this->userTypeId = $userTypeId;
$this->homePageId = $homePageId;
$this->newPassword = $newPassword;
$this->retypeNewPassword = $retypeNewPassword;
$this->newUserWizard = $newUserWizard;
$this->hideNavigation = $hideNavigation;
$this->email = $email;
$this->libraryQuota = $libraryQuota;
$this->isPasswordChangeRequired = $isPasswordChangeRequired;
$this->firstName = $firstName;
$this->lastName = $lastName;
$this->phone = $phone;
$this->ref1 = $ref1;
$this->ref2 = $ref2;
$this->ref3 = $ref3;
$this->ref4 = $ref4;
$this->ref5 = $ref5;
$this->getLogger()->info('Editing User ID ' . $userId);
$response = $this->doPut('/user/' . $userId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
/** @var XiboUser $user */
$user = $this->hydrate($response);
return $user;
} | [
"public",
"function",
"edit",
"(",
"$",
"userId",
",",
"$",
"userName",
",",
"$",
"userTypeId",
",",
"$",
"homePageId",
",",
"$",
"newUserWizard",
",",
"$",
"hideNavigation",
",",
"$",
"newPassword",
"=",
"''",
",",
"$",
"retypeNewPassword",
"=",
"''",
"... | Edit an existing User.
@param int $userId The User ID to edit
@param string $userName The User Name
@param int $userTypeId The user type id
@param int $homePageId The homepage ID to use for this User
@param string $newPassword New Password for the User
@param string $retypeNewPassword New Password for the User retyped
@param int $newUserWizard Flag indicating whether to show the new user guide
@param int $hideNavigation Flag indicating whether to hide the navigation
@param string $email The User email address
@param int $libraryQuota The Users library quota in kilobytes
@param int $isPasswordChangeRequired A flag indicating whether password change should be forced for this user
@param string $firstName The User first name
@param string $lastName The User Last name
@param string $phone The user phone number
@param string $ref1 Reference 1
@param string $ref2 Reference 2
@param string $ref3 Reference 3
@param string $ref4 Reference 4
@param string $ref5 Reference 5
@return XiboUser | [
"Edit",
"an",
"existing",
"User",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUser.php#L325-L355 |
45,276 | xibosignage/oauth2-xibo-cms | src/Entity/XiboUser.php | XiboUser.delete | public function delete($deleteAllItems = 0, $reassignUserId = null)
{
$this->getLogger()->info('Deleting User ID ' . $this->userId);
$this->doDelete('/user/' . $this->userId, [
'deleteAllItems' => $deleteAllItems,
'reassignUserId' => $reassignUserId
]);
return true;
} | php | public function delete($deleteAllItems = 0, $reassignUserId = null)
{
$this->getLogger()->info('Deleting User ID ' . $this->userId);
$this->doDelete('/user/' . $this->userId, [
'deleteAllItems' => $deleteAllItems,
'reassignUserId' => $reassignUserId
]);
return true;
} | [
"public",
"function",
"delete",
"(",
"$",
"deleteAllItems",
"=",
"0",
",",
"$",
"reassignUserId",
"=",
"null",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting User ID '",
".",
"$",
"this",
"->",
"userId",
")",
";",
"$"... | Delete the User.
@param int $deleteAllItems Flag indicating whether to delete all items owned by that user
@param int $reassignUserId Reassign all items owned by this user to the specified user ID
@return bool | [
"Delete",
"the",
"User",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboUser.php#L364-L373 |
45,277 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplay.php | XiboDisplay.delete | public function delete()
{
$this->getLogger()->info('Deleting display ID ' . $this->displayId);
$this->doDelete('/display/' . $this->displayId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting display ID ' . $this->displayId);
$this->doDelete('/display/' . $this->displayId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting display ID '",
".",
"$",
"this",
"->",
"displayId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/display/'",
".",
"$",
"this",
"-... | Delete the display.
@return bool | [
"Delete",
"the",
"display",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplay.php#L256-L262 |
45,278 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplay.php | XiboDisplay.screenshot | public function screenshot()
{
$this->getLogger()->info('Requesting a screenshot from display ID ' . $this->displayId);
$this->doPut('/display/requestscreenshot/' . $this->displayId);
} | php | public function screenshot()
{
$this->getLogger()->info('Requesting a screenshot from display ID ' . $this->displayId);
$this->doPut('/display/requestscreenshot/' . $this->displayId);
} | [
"public",
"function",
"screenshot",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Requesting a screenshot from display ID '",
".",
"$",
"this",
"->",
"displayId",
")",
";",
"$",
"this",
"->",
"doPut",
"(",
"'/display/requestscre... | Request screenshot from this display. | [
"Request",
"screenshot",
"from",
"this",
"display",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplay.php#L268-L272 |
45,279 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplay.php | XiboDisplay.wol | public function wol()
{
$this->getLogger()->info('Sending WoL request to display ID ' . $this->displayId);
$this->doPost('/display/wol/' . $this->displayId);
} | php | public function wol()
{
$this->getLogger()->info('Sending WoL request to display ID ' . $this->displayId);
$this->doPost('/display/wol/' . $this->displayId);
} | [
"public",
"function",
"wol",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Sending WoL request to display ID '",
".",
"$",
"this",
"->",
"displayId",
")",
";",
"$",
"this",
"->",
"doPost",
"(",
"'/display/wol/'",
".",
"$",
... | Wake On Lan. | [
"Wake",
"On",
"Lan",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplay.php#L278-L282 |
45,280 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplay.php | XiboDisplay.authorise | public function authorise()
{
$this->getLogger()->info('Setting Authorise for display ID ' . $this->displayId);
$this->doPut('/display/authorise/' . $this->displayId);
} | php | public function authorise()
{
$this->getLogger()->info('Setting Authorise for display ID ' . $this->displayId);
$this->doPut('/display/authorise/' . $this->displayId);
} | [
"public",
"function",
"authorise",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Setting Authorise for display ID '",
".",
"$",
"this",
"->",
"displayId",
")",
";",
"$",
"this",
"->",
"doPut",
"(",
"'/display/authorise/'",
"."... | Authorise the display. | [
"Authorise",
"the",
"display",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplay.php#L289-L293 |
45,281 | xibosignage/oauth2-xibo-cms | src/Entity/XiboDisplay.php | XiboDisplay.defaultLayout | public function defaultLayout($layoutId)
{
$this->getLogger()->info('Setting Default layout ID ' . $layoutId . ' for display ID ' . $this->displayId);
$this->doPut('/display/defaultlayout/' . $this->displayId, [
'layoutId' => $layoutId
]);
} | php | public function defaultLayout($layoutId)
{
$this->getLogger()->info('Setting Default layout ID ' . $layoutId . ' for display ID ' . $this->displayId);
$this->doPut('/display/defaultlayout/' . $this->displayId, [
'layoutId' => $layoutId
]);
} | [
"public",
"function",
"defaultLayout",
"(",
"$",
"layoutId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Setting Default layout ID '",
".",
"$",
"layoutId",
".",
"' for display ID '",
".",
"$",
"this",
"->",
"displayId",
")",
";"... | Set the default layout for the display.
@param int $layoutId The ID of the default layout | [
"Set",
"the",
"default",
"layout",
"for",
"the",
"display",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboDisplay.php#L301-L307 |
45,282 | xibosignage/oauth2-xibo-cms | src/Entity/XiboNotification.php | XiboNotification.create | public function create($subject, $body, $releaseDt, $isEmail, $isInterrupt, $displayGroupIds = [], $userGroupIds = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->subject = $subject;
$this->body = $body;
$this->releaseDt = $releaseDt;
$this->isEmail = $isEmail;
$this->isInterrupt = $isInterrupt;
$this->displayGroupIds = $displayGroupIds;
$this->userGroupIds = $userGroupIds;
$this->getLogger()->info('Creating Notification ' . $subject);
$response = $this->doPost('/notification', $this->toArray());
return $this->hydrate($response);
} | php | public function create($subject, $body, $releaseDt, $isEmail, $isInterrupt, $displayGroupIds = [], $userGroupIds = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->subject = $subject;
$this->body = $body;
$this->releaseDt = $releaseDt;
$this->isEmail = $isEmail;
$this->isInterrupt = $isInterrupt;
$this->displayGroupIds = $displayGroupIds;
$this->userGroupIds = $userGroupIds;
$this->getLogger()->info('Creating Notification ' . $subject);
$response = $this->doPost('/notification', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"subject",
",",
"$",
"body",
",",
"$",
"releaseDt",
",",
"$",
"isEmail",
",",
"$",
"isInterrupt",
",",
"$",
"displayGroupIds",
"=",
"[",
"]",
",",
"$",
"userGroupIds",
"=",
"[",
"]",
")",
"{",
"$",
"this",
... | Create new Notification.
@param string $subject The Notification Subject
@param string $body The Notification message
@param string $releaseDt ISO date representing the release date for this notification
@param int $isEmail Flag indicating whether this notification should be emailed
@param int $isInterrupt Flag indicating whether this notification should interrupt the web portal nativation/login
@param array[int] $displayGroupIds The display group ids to assign this notification to
@param array[int] $userGroupIds The user group ids to assign to this notification
@return XiboNotification | [
"Create",
"new",
"Notification",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboNotification.php#L96-L111 |
45,283 | xibosignage/oauth2-xibo-cms | src/Entity/XiboNotification.php | XiboNotification.edit | public function edit($notificationId, $subject, $body, $releaseDt, $isEmail, $isInterrupt, $displayGroupIds = [], $userGroupIds = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->notificationId = $notificationId;
$this->subject = $subject;
$this->body = $body;
$this->releaseDt = $releaseDt;
$this->isEmail = $isEmail;
$this->isInterrupt = $isInterrupt;
$this->displayGroupIds = $displayGroupIds;
$this->userGroupIds = $userGroupIds;
$this->getLogger()->info('Editing Notification ID' . $notificationId);
$response = $this->doPut('/notification', $this->toArray());
return $this->hydrate($response);
} | php | public function edit($notificationId, $subject, $body, $releaseDt, $isEmail, $isInterrupt, $displayGroupIds = [], $userGroupIds = [])
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->notificationId = $notificationId;
$this->subject = $subject;
$this->body = $body;
$this->releaseDt = $releaseDt;
$this->isEmail = $isEmail;
$this->isInterrupt = $isInterrupt;
$this->displayGroupIds = $displayGroupIds;
$this->userGroupIds = $userGroupIds;
$this->getLogger()->info('Editing Notification ID' . $notificationId);
$response = $this->doPut('/notification', $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"notificationId",
",",
"$",
"subject",
",",
"$",
"body",
",",
"$",
"releaseDt",
",",
"$",
"isEmail",
",",
"$",
"isInterrupt",
",",
"$",
"displayGroupIds",
"=",
"[",
"]",
",",
"$",
"userGroupIds",
"=",
"[",
"]",
... | Edit the Notification.
@param int $notificationId Notification ID
@param string $subject The Notification Subject
@param string $body The Notification message
@param string $releaseDt ISO date representing the release date for this notification
@param int $isEmail Flag indicating whether this notification should be emailed
@param int $isInterrupt Flag indicating whether this notification should interrupt the web portal nativation/login
@param array[int] $displayGroupIds The display group ids to assign this notification to
@param array[int] $userGroupIds The user group ids to assign to this notification
@return XiboNotification | [
"Edit",
"the",
"Notification",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboNotification.php#L126-L142 |
45,284 | xibosignage/oauth2-xibo-cms | src/Entity/XiboWeather.php | XiboWeather.create | public function create($name, $duration, $useDuration, $useDisplayLocation, $longitude, $latitude, $templateId, $units, $updateInterval, $lang, $dayConditionsOnly, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->useDisplayLocation = $useDisplayLocation;
$this->longitude = $longitude;
$this->latitude = $latitude;
$this->templateId = $templateId;
$this->units = $units;
$this->updateInterval = $updateInterval;
$this->lang = $lang;
$this->dayConditionsOnly = $dayConditionsOnly;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Weather widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/forecastIo/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $useDisplayLocation, $longitude, $latitude, $templateId, $units, $updateInterval, $lang, $dayConditionsOnly, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->useDisplayLocation = $useDisplayLocation;
$this->longitude = $longitude;
$this->latitude = $latitude;
$this->templateId = $templateId;
$this->units = $units;
$this->updateInterval = $updateInterval;
$this->lang = $lang;
$this->dayConditionsOnly = $dayConditionsOnly;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Weather widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/forecastIo/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"useDisplayLocation",
",",
"$",
"longitude",
",",
"$",
"latitude",
",",
"$",
"templateId",
",",
"$",
"units",
",",
"$",
"updateInterval",
",",
"$",... | Create Weather Widget.
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $useDisplayLocation Flag Use the location configured on the Display?
@param double $longitude The longitude for this Google Traffic widget, only pass if useDisplayLocation set to 0
@param double $latitude he latitude for this Google Traffic widget, only pass if useDisplayLocation set to 0
@param string $templateId Use pre-configured templates, available options: weather-module0-5day, weather-module0-singleday, weather-module0-singleday2, weather-module1l, weather-module1p, weather-module2l, weather-module2p, weather-module3l, weather-module3p, weather-module4l, weather-module4p, weather-module5l, weather-module6v, weather-module6h
@param string $units Units you would like to use, available options: auto, ca, si, uk2, us
@param int $updateInterval Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60
@param string $lang Language you’d like to use, supported languages ar, az, be, bs, cs, de, en, el, es, fr, hr, hu, id, it, is, kw, nb, nl, pl, pt, ru, sk, sr, sv, tet, tr, uk, x-pig-latin, zh, zh-tw
@param int $dayConditionsOnly Flag (0, 1) Would you like to only show the Daytime weather conditions
@param int $playlistId Playlist ID
@return XiboWeather | [
"Create",
"Weather",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboWeather.php#L96-L116 |
45,285 | xibosignage/oauth2-xibo-cms | src/Entity/XiboWeather.php | XiboWeather.edit | public function edit($name, $duration, $useDuration, $useDisplayLocation, $longitude, $latitude, $templateId, $units, $updateInterval, $lang, $dayConditionsOnly, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->useDisplayLocation = $useDisplayLocation;
$this->longitude = $longitude;
$this->latitude = $latitude;
$this->templateId = $templateId;
$this->units = $units;
$this->updateInterval = $updateInterval;
$this->lang = $lang;
$this->dayConditionsOnly = $dayConditionsOnly;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing Weather widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $useDisplayLocation, $longitude, $latitude, $templateId, $units, $updateInterval, $lang, $dayConditionsOnly, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->useDisplayLocation = $useDisplayLocation;
$this->longitude = $longitude;
$this->latitude = $latitude;
$this->templateId = $templateId;
$this->units = $units;
$this->updateInterval = $updateInterval;
$this->lang = $lang;
$this->dayConditionsOnly = $dayConditionsOnly;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing Weather widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"useDisplayLocation",
",",
"$",
"longitude",
",",
"$",
"latitude",
",",
"$",
"templateId",
",",
"$",
"units",
",",
"$",
"updateInterval",
",",
"$",
... | Edit Weather widget
@param string $name Optional widget name
@param int $duration Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $useDisplayLocation Flag Use the location configured on the Display?
@param double $longitude The longitude for this Google Traffic widget, only pass if useDisplayLocation set to 0
@param double $latitude he latitude for this Google Traffic widget, only pass if useDisplayLocation set to 0
@param string $templateId Use pre-configured templates, available options: weather-module0-5day, weather-module0-singleday, weather-module0-singleday2, weather-module1l, weather-module1p, weather-module2l, weather-module2p, weather-module3l, weather-module3p, weather-module4l, weather-module4p, weather-module5l, weather-module6v, weather-module6h
@param string $units Units you would like to use, available options: auto, ca, si, uk2, us
@param int $updateInterval Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60
@param string $lang Language you’d like to use, supported languages ar, az, be, bs, cs, de, en, el, es, fr, hr, hu, id, it, is, kw, nb, nl, pl, pt, ru, sk, sr, sv, tet, tr, uk, x-pig-latin, zh, zh-tw
@param int $dayConditionsOnly Flag (0, 1) Would you like to only show the Daytime weather conditions
@param int $widgetId Widget ID
@return XiboWeather | [
"Edit",
"Weather",
"widget"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboWeather.php#L134-L153 |
45,286 | xibosignage/oauth2-xibo-cms | src/Entity/XiboWebpage.php | XiboWebpage.create | public function create($name, $duration, $useDuration, $transparency, $uri, $scaling, $offsetLeft, $offsetTop, $pageWidth, $pageHeight, $modeId, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->transparency = $transparency;
$this->uri = $uri;
$this->scaling = $scaling;
$this->offsetLeft = $offsetLeft;
$this->offsetTop = $offsetTop;
$this->pageWidth = $pageWidth;
$this->pageHeight = $pageHeight;
$this->modeId = $modeId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating a new Webpage widget in playlist ID ' .$playlistId);
$response = $this->doPost('/playlist/widget/webpage/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $transparency, $uri, $scaling, $offsetLeft, $offsetTop, $pageWidth, $pageHeight, $modeId, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->transparency = $transparency;
$this->uri = $uri;
$this->scaling = $scaling;
$this->offsetLeft = $offsetLeft;
$this->offsetTop = $offsetTop;
$this->pageWidth = $pageWidth;
$this->pageHeight = $pageHeight;
$this->modeId = $modeId;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating a new Webpage widget in playlist ID ' .$playlistId);
$response = $this->doPost('/playlist/widget/webpage/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"transparency",
",",
"$",
"uri",
",",
"$",
"scaling",
",",
"$",
"offsetLeft",
",",
"$",
"offsetTop",
",",
"$",
"pageWidth",
",",
"$",
"pageHeight... | Create new Webpage Widget.
@param string $name Optional Widget
@param int $duration The Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $transparency Flag should the HTML be shown with a transparent background?
@param string $uri String containing the location (URL) of the web page
@param int $scaling For Manual position the percentage to scale the Web page (0-100)
@param int $offsetLeft For Manual position, the starting point from the left in pixels
@param int $offsetTop For Manual position, the starting point from the Top in pixels
@param int $pageWidth For Manual Position and Best Fit, The width of the page - if empty it will use region width
@param int $pageHeight For Manual Position and Best Fit, The height of the page - if empty it will use region height
@param int $modeId The mode option for Web page, 1- Open Natively, 2- Manual Position, 3- Best Ft
@param int $playlistId The Playlist ID
@return XiboWebpage | [
"Create",
"new",
"Webpage",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboWebpage.php#L97-L116 |
45,287 | xibosignage/oauth2-xibo-cms | src/Entity/XiboWebpage.php | XiboWebpage.edit | public function edit($name, $duration, $useDuration, $transparency, $uri, $scaling, $offsetLeft, $offsetTop, $pageWidth, $pageHeight, $modeId, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->transparency = $transparency;
$this->uri = $uri;
$this->scaling = $scaling;
$this->offsetLeft = $offsetLeft;
$this->offsetTop = $offsetTop;
$this->pageWidth = $pageWidth;
$this->pageHeight = $pageHeight;
$this->modeId = $modeId;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $transparency, $uri, $scaling, $offsetLeft, $offsetTop, $pageWidth, $pageHeight, $modeId, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->transparency = $transparency;
$this->uri = $uri;
$this->scaling = $scaling;
$this->offsetLeft = $offsetLeft;
$this->offsetTop = $offsetTop;
$this->pageWidth = $pageWidth;
$this->pageHeight = $pageHeight;
$this->modeId = $modeId;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"transparency",
",",
"$",
"uri",
",",
"$",
"scaling",
",",
"$",
"offsetLeft",
",",
"$",
"offsetTop",
",",
"$",
"pageWidth",
",",
"$",
"pageHeight",... | Edit existing Webpage Widget.
@param string $name Optional Widget
@param int $duration The Widget Duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $transparency Flag should the HTML be shown with a transparent background?
@param string $uri String containing the location (URL) of the web page
@param int $scaling For Manual position the percentage to scale the Web page (0-100)
@param int $offsetLeft For Manual position, the starting point from the left in pixels
@param int $offsetTop For Manual position, the starting point from the Top in pixels
@param int $pageWidth For Manual Position and Best Fit, The width of the page - if empty it will use region width
@param int $pageHeight For Manual Position and Best Fit, The height of the page - if empty it will use region height
@param int $modeId The mode option for Web page, 1- Open Natively, 2- Manual Position, 3- Best Ft
@param int $widgetId The Widget ID
@return XiboWebpage | [
"Edit",
"existing",
"Webpage",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboWebpage.php#L135-L154 |
45,288 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPlayerSoftware.php | XiboPlayerSoftware.edit | public function edit($versionId, $playerShowVersion, $version, $code)
{
$this->playerShowVersion = $playerShowVersion;
$this->version = $version;
$this->code = $code;
$this->getLogger()->info('Editing Player Software version ID ' . $versionId);
$response = $this->doPut('/playersoftware/' . $versionId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | php | public function edit($versionId, $playerShowVersion, $version, $code)
{
$this->playerShowVersion = $playerShowVersion;
$this->version = $version;
$this->code = $code;
$this->getLogger()->info('Editing Player Software version ID ' . $versionId);
$response = $this->doPut('/playersoftware/' . $versionId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"versionId",
",",
"$",
"playerShowVersion",
",",
"$",
"version",
",",
"$",
"code",
")",
"{",
"$",
"this",
"->",
"playerShowVersion",
"=",
"$",
"playerShowVersion",
";",
"$",
"this",
"->",
"version",
"=",
"$",
"vers... | Edit an existing Player Version.
@param int $versionId The Version ID of the installer file to edit
@param string $playerShowVersion Player version to show
@param string $version Version of the installer file
@param int $code Code of the installer file
@return XiboPlayerSoftware | [
"Edit",
"an",
"existing",
"Player",
"Version",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPlayerSoftware.php#L127-L137 |
45,289 | xibosignage/oauth2-xibo-cms | src/Entity/XiboPlayerSoftware.php | XiboPlayerSoftware.delete | public function delete()
{
$this->getLogger()->info('Deleting Player Version version ID ' . $this->versionId);
$this->doDelete('/playersoftware/' . $this->versionId);
return true;
} | php | public function delete()
{
$this->getLogger()->info('Deleting Player Version version ID ' . $this->versionId);
$this->doDelete('/playersoftware/' . $this->versionId);
return true;
} | [
"public",
"function",
"delete",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Deleting Player Version version ID '",
".",
"$",
"this",
"->",
"versionId",
")",
";",
"$",
"this",
"->",
"doDelete",
"(",
"'/playersoftware/'",
".",... | Delete the Player Version
@return bool | [
"Delete",
"the",
"Player",
"Version"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboPlayerSoftware.php#L144-L150 |
45,290 | xibosignage/oauth2-xibo-cms | src/Entity/XiboFinance.php | XiboFinance.create | public function create($templateId, $name, $duration, $useDuration, $item, $effect, $speed, $backgroundColor, $noRecordsMessage, $dateFormat, $updateInterval, $durationIsPerItem, $overrideTemplate, $yql, $resultIdentifier, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->overrideTemplate = 0;
$this->templateId = $templateId;
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->item = $item;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->noRecordsMessage = $noRecordsMessage;
$this->dateFormat = $dateFormat;
$this->updateInterval = $updateInterval;
$this->durationIsPerItem = $durationIsPerItem;
$this->overrideTemplate = $overrideTemplate;
$this->yql = $yql;
$this->resultIdentifier = $resultIdentifier;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Finance widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/finance/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | php | public function create($templateId, $name, $duration, $useDuration, $item, $effect, $speed, $backgroundColor, $noRecordsMessage, $dateFormat, $updateInterval, $durationIsPerItem, $overrideTemplate, $yql, $resultIdentifier, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->overrideTemplate = 0;
$this->templateId = $templateId;
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->item = $item;
$this->effect = $effect;
$this->speed = $speed;
$this->backgroundColor = $backgroundColor;
$this->noRecordsMessage = $noRecordsMessage;
$this->dateFormat = $dateFormat;
$this->updateInterval = $updateInterval;
$this->durationIsPerItem = $durationIsPerItem;
$this->overrideTemplate = $overrideTemplate;
$this->yql = $yql;
$this->resultIdentifier = $resultIdentifier;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Finance widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/finance/' . $playlistId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"templateId",
",",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"item",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"backgroundColor",
",",
"$",
"noRecordsMessage",
",",
"$",
"date... | Create Finance Widget.
@param string $templateId Use pre-configured templates, available options: currency-simple, stock-simple
@param string $name Widget Name
@param int $duration Widget Duration
@param int $useDuration Flag Select 1 only if you will provide duration parameter as well
@param string $item Items wanted, can be comma separated (example EURUSD, GBPUSD)
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft
@param int $speed The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)
@param string $backgroundColor A HEX color to use as the background color of this widget
@param string $noRecordsMessage A message to display when there are no records returned by the search query
@param string $dateFormat The format to apply to all dates returned by he widget
@param int $updateInterval Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60
@param int $durationIsPerItem Flag The duration specified is per item, otherwise the widget duration is divided between the number of items
@param int $overrideTemplate flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters
@param string $yql The YQL query to use for data, pass only with overrideTemplate set to 1
@param string $resultIdentifier The name of the result identifier returned by the YQL, pass only with overrideTemplate set to 1
@param int $playlistId Playlist ID
@return XiboFinance | [
"Create",
"Finance",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboFinance.php#L121-L145 |
45,291 | xibosignage/oauth2-xibo-cms | src/Entity/XiboWidget.php | XiboWidget.getById | public function getById($widgetId)
{
$this->getLogger()->info('Getting widget ID ' . $widgetId);
$response = $this->doGet('/playlist/widget', [
'widgetId' => $widgetId
]);
$resonse = clone $this->hydrate($response[0]);
if ($response[0]['type'] != $this->type)
throw new XiboApiException('Invalid widget type');
return $this;
} | php | public function getById($widgetId)
{
$this->getLogger()->info('Getting widget ID ' . $widgetId);
$response = $this->doGet('/playlist/widget', [
'widgetId' => $widgetId
]);
$resonse = clone $this->hydrate($response[0]);
if ($response[0]['type'] != $this->type)
throw new XiboApiException('Invalid widget type');
return $this;
} | [
"public",
"function",
"getById",
"(",
"$",
"widgetId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting widget ID '",
".",
"$",
"widgetId",
")",
";",
"$",
"response",
"=",
"$",
"this",
"->",
"doGet",
"(",
"'/playlist/widge... | Get by Id
@param int $widgetId Widget ID
@return $this|XiboWidget
@throws XiboApiException | [
"Get",
"by",
"Id"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboWidget.php#L85-L97 |
45,292 | xibosignage/oauth2-xibo-cms | src/Entity/XiboNotificationView.php | XiboNotificationView.create | public function create($name, $duration, $useDuration, $age, $noDataMessage, $effect, $speed, $durationIsPerItem, $embedStyle = null, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->age = $age;
$this->noDataMessage = $noDataMessage;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->embedStyle = $embedStyle;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Notification widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/notificationview/' . $playlistId, $this->toArray());
return $this->hydrate($response);
} | php | public function create($name, $duration, $useDuration, $age, $noDataMessage, $effect, $speed, $durationIsPerItem, $embedStyle = null, $playlistId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->age = $age;
$this->noDataMessage = $noDataMessage;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->embedStyle = $embedStyle;
$this->playlistId = $playlistId;
$this->getLogger()->info('Creating Notification widget in playlist ID ' . $playlistId);
$response = $this->doPost('/playlist/widget/notificationview/' . $playlistId, $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"age",
",",
"$",
"noDataMessage",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"durationIsPerItem",
",",
"$",
"embedStyle",
"=",
"null",
",",... | Create NotificationView widget.
@param string $name Optional widget name
@param int $duration Widget duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $age The maximum notification age in minutes, 0 for all
@param string $noDataMessage Message to show when no notifications are available
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind
@param int $speed The transition speed of the selected effect in milliseconds
@param int $durationIsPerItem Flag The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items
@param string $embedStyle Custom Style Sheets (CSS)
@param int $playlistId Playlist ID
@return XiboNotificationView | [
"Create",
"NotificationView",
"widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboNotificationView.php#L88-L105 |
45,293 | xibosignage/oauth2-xibo-cms | src/Entity/XiboNotificationView.php | XiboNotificationView.edit | public function edit($name, $duration, $useDuration, $age, $noDataMessage, $effect, $speed, $durationIsPerItem, $embedStyle = null, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->age = $age;
$this->noDataMessage = $noDataMessage;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->embedStyle = $embedStyle;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | php | public function edit($name, $duration, $useDuration, $age, $noDataMessage, $effect, $speed, $durationIsPerItem, $embedStyle = null, $widgetId)
{
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->duration = $duration;
$this->useDuration = $useDuration;
$this->age = $age;
$this->noDataMessage = $noDataMessage;
$this->effect = $effect;
$this->speed = $speed;
$this->durationIsPerItem = $durationIsPerItem;
$this->embedStyle = $embedStyle;
$this->widgetId = $widgetId;
$this->getLogger()->info('Editing widget ID ' . $widgetId);
$response = $this->doPut('/playlist/widget/' . $widgetId , $this->toArray());
return $this->hydrate($response);
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"duration",
",",
"$",
"useDuration",
",",
"$",
"age",
",",
"$",
"noDataMessage",
",",
"$",
"effect",
",",
"$",
"speed",
",",
"$",
"durationIsPerItem",
",",
"$",
"embedStyle",
"=",
"null",
",",
... | Edit Existing NotificationView Widget.
@param string $name Optional widget name
@param int $duration Widget duration
@param int $useDuration Flag indicating whether to use custom duration
@param int $age The maximum notification age in minutes, 0 for all
@param string $noDataMessage Message to show when no notifications are available
@param string $effect Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind
@param int $speed The transition speed of the selected effect in milliseconds
@param int $durationIsPerItem Flag The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items
@param string $embedStyle Custom Style Sheets (CSS)
@param int $widgetId Widget ID
@return XiboNotificationView | [
"Edit",
"Existing",
"NotificationView",
"Widget",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboNotificationView.php#L122-L139 |
45,294 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.get | public function get(array $params = [])
{
$this->getLogger()->info('Getting list of layouts ');
$entries = [];
$hydratedRegions = [];
$hydratedWidgets = [];
$response = $this->doGet($this->url, $params);
if (isset($params['embed']))
$embed = ($params['embed'] != null) ? explode(',', $params['embed']) : [];
foreach ($response as $item) {
/** @var XiboLayout $layout */
$layout = new XiboLayout($this->getEntityProvider());
$layout->hydrate($item);
foreach ($layout->regions as $reg) {
/** @var XiboRegion $region */
$region = new XiboRegion($this->getEntityProvider());
$region->hydrate($reg);
if (in_array('playlists', $embed) === true) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($reg['regionPlaylist']);
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
$region->regionPlaylist = $playlist;
}
// Add to parent object
$hydratedRegions[] = $region;
}
$layout->regions = $hydratedRegions;
$entries[] = clone $layout;
}
return $entries;
} | php | public function get(array $params = [])
{
$this->getLogger()->info('Getting list of layouts ');
$entries = [];
$hydratedRegions = [];
$hydratedWidgets = [];
$response = $this->doGet($this->url, $params);
if (isset($params['embed']))
$embed = ($params['embed'] != null) ? explode(',', $params['embed']) : [];
foreach ($response as $item) {
/** @var XiboLayout $layout */
$layout = new XiboLayout($this->getEntityProvider());
$layout->hydrate($item);
foreach ($layout->regions as $reg) {
/** @var XiboRegion $region */
$region = new XiboRegion($this->getEntityProvider());
$region->hydrate($reg);
if (in_array('playlists', $embed) === true) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($reg['regionPlaylist']);
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
$region->regionPlaylist = $playlist;
}
// Add to parent object
$hydratedRegions[] = $region;
}
$layout->regions = $hydratedRegions;
$entries[] = clone $layout;
}
return $entries;
} | [
"public",
"function",
"get",
"(",
"array",
"$",
"params",
"=",
"[",
"]",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting list of layouts '",
")",
";",
"$",
"entries",
"=",
"[",
"]",
";",
"$",
"hydratedRegions",
"=",
"... | Get an array of layouts.
@param array $params can be filtered by: layoutId, layout, userId, retired, tags, exactTags, ownerUserGroupId and embeddable parameter embed=regions, playlists, widgets, tags
@return array|XiboLayout | [
"Get",
"an",
"array",
"of",
"layouts",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L130-L170 |
45,295 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.getById | public function getById($id, $embed = '')
{
$this->getLogger()->info('Getting layout ID ' . $id);
$hydratedRegions = [];
$hydratedWidgets = [];
$response = $this->doGet($this->url, [
'layoutId' => $id, 'retired' => -1, 'embed' => $embed
]);
if (count($response) <= 0)
throw new XiboApiException('Expecting a single record, found ' . count($response));
/** @var XiboLayout $layout */
$layout = $this->hydrate($response[0]);
foreach ($layout->regions as $item) {
/** @var XiboRegion $region */
$region = new XiboRegion($this->getEntityProvider());
$region->hydrate($item);
if (strpos($embed, 'playlists') !== false) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($item['regionPlaylist']);
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
$region->regionPlaylist = $playlist;
}
// Add to parent object
$hydratedRegions[] = $region;
}
$layout->regions = $hydratedRegions;
return clone $layout;
} | php | public function getById($id, $embed = '')
{
$this->getLogger()->info('Getting layout ID ' . $id);
$hydratedRegions = [];
$hydratedWidgets = [];
$response = $this->doGet($this->url, [
'layoutId' => $id, 'retired' => -1, 'embed' => $embed
]);
if (count($response) <= 0)
throw new XiboApiException('Expecting a single record, found ' . count($response));
/** @var XiboLayout $layout */
$layout = $this->hydrate($response[0]);
foreach ($layout->regions as $item) {
/** @var XiboRegion $region */
$region = new XiboRegion($this->getEntityProvider());
$region->hydrate($item);
if (strpos($embed, 'playlists') !== false) {
/** @var XiboPlaylist $playlist */
$playlist = new XiboPlaylist($this->getEntityProvider());
$playlist->hydrate($item['regionPlaylist']);
foreach ($playlist->widgets as $widget) {
/** @var XiboWidget $widgetObject */
$widgetObject = new XiboWidget($this->getEntityProvider());
$widgetObject->hydrate($widget);
$hydratedWidgets[] = $widgetObject;
}
$playlist->widgets = $hydratedWidgets;
$region->regionPlaylist = $playlist;
}
// Add to parent object
$hydratedRegions[] = $region;
}
$layout->regions = $hydratedRegions;
return clone $layout;
} | [
"public",
"function",
"getById",
"(",
"$",
"id",
",",
"$",
"embed",
"=",
"''",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Getting layout ID '",
".",
"$",
"id",
")",
";",
"$",
"hydratedRegions",
"=",
"[",
"]",
";",
"$",... | Get the layout by its ID.
@param int $id LayoutId to search for
@param string $embed A comma separated list of related data tp embed such as regions, playlists, widgets, tags, etc
@return XiboLayout
@throws XiboApiException | [
"Get",
"the",
"layout",
"by",
"its",
"ID",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L180-L218 |
45,296 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.create | public function create($name, $description, $layoutId, $resolutionId)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->description = $description;
$this->layoutId = $layoutId;
$this->resolutionId = $resolutionId;
$this->getLogger()->info('Creating Layout ' . $this->layout);
$response = $this->doPost('/layout', $this->toArray());
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | php | public function create($name, $description, $layoutId, $resolutionId)
{
$this->getLogger()->debug('Getting Resource Owner');
$this->userId = $this->getEntityProvider()->getMe()->getId();
$this->name = $name;
$this->description = $description;
$this->layoutId = $layoutId;
$this->resolutionId = $resolutionId;
$this->getLogger()->info('Creating Layout ' . $this->layout);
$response = $this->doPost('/layout', $this->toArray());
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | [
"public",
"function",
"create",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"layoutId",
",",
"$",
"resolutionId",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"debug",
"(",
"'Getting Resource Owner'",
")",
";",
"$",
"this",
"->",
... | Create a new layout.
Creates new layout with the specified parameters
@param string $name Name of the layout
@param string $description Optional description of the layout
@param int $layoutId If layout should be created from the template, provide the layoutId of the template
@param int $resolutionId If template is not provided, provide resolutionId
@return XiboLayout
@throws InvalidArgumentException | [
"Create",
"a",
"new",
"layout",
".",
"Creates",
"new",
"layout",
"with",
"the",
"specified",
"parameters"
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L231-L246 |
45,297 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.edit | public function edit($name, $description, $tags, $retired, $backgroundColor,$backgroundImageId, $backgroundzIndex, $resolutionId)
{
$this->name = $name;
$this->description = $description;
$this->tags = $tags;
$this->retired = $retired;
$this->backgroundColor = $backgroundColor;
$this->backgroundImageId = $backgroundImageId;
$this->backgroundzIndex = $backgroundzIndex;
$this->resolutionId = $resolutionId;
$this->getLogger()->info('Editing Layout ID ' . $this->layoutId);
$response = $this->doPut('/layout/' . $this->layoutId, $this->toArray());
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | php | public function edit($name, $description, $tags, $retired, $backgroundColor,$backgroundImageId, $backgroundzIndex, $resolutionId)
{
$this->name = $name;
$this->description = $description;
$this->tags = $tags;
$this->retired = $retired;
$this->backgroundColor = $backgroundColor;
$this->backgroundImageId = $backgroundImageId;
$this->backgroundzIndex = $backgroundzIndex;
$this->resolutionId = $resolutionId;
$this->getLogger()->info('Editing Layout ID ' . $this->layoutId);
$response = $this->doPut('/layout/' . $this->layoutId, $this->toArray());
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | [
"public",
"function",
"edit",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"tags",
",",
"$",
"retired",
",",
"$",
"backgroundColor",
",",
"$",
"backgroundImageId",
",",
"$",
"backgroundzIndex",
",",
"$",
"resolutionId",
")",
"{",
"$",
"this",
"->... | Edit an existing Layout.
@param string $name new name of the layout
@param string $description new description of the layout
@param string $tags comma separated list of tags
@param int $retired flag indicating whether this layout is retired
@param string $backgroundColor A HEX color to use as layout background
@param int $backgroundImageId Media ID to use as a layout background
@param int $backgroundzIndex The layer number to use for the background
@param int $resolutionId new Resolution to use for this layout
@return XiboLayout | [
"Edit",
"an",
"existing",
"Layout",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L261-L278 |
45,298 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.retire | public function retire()
{
$this->getLogger()->info('Retiring layout ID ' . $this->layoutId);
$this->doPut('/layout/retire/' . $this->layoutId);
return true;
} | php | public function retire()
{
$this->getLogger()->info('Retiring layout ID ' . $this->layoutId);
$this->doPut('/layout/retire/' . $this->layoutId);
return true;
} | [
"public",
"function",
"retire",
"(",
")",
"{",
"$",
"this",
"->",
"getLogger",
"(",
")",
"->",
"info",
"(",
"'Retiring layout ID '",
".",
"$",
"this",
"->",
"layoutId",
")",
";",
"$",
"this",
"->",
"doPut",
"(",
"'/layout/retire/'",
".",
"$",
"this",
"... | Retire the specified layout.
@return bool | [
"Retire",
"the",
"specified",
"layout",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L300-L306 |
45,299 | xibosignage/oauth2-xibo-cms | src/Entity/XiboLayout.php | XiboLayout.copy | public function copy($name, $description, $copyMediaFiles)
{
$this->name = $name;
$this->description = $description;
$this->copyMediaFiles = $copyMediaFiles;
$this->getLogger()->info('Copy Layout ID ' . $this->layoutId);
$response = $this->doPost('/layout/copy/' . $this->layoutId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | php | public function copy($name, $description, $copyMediaFiles)
{
$this->name = $name;
$this->description = $description;
$this->copyMediaFiles = $copyMediaFiles;
$this->getLogger()->info('Copy Layout ID ' . $this->layoutId);
$response = $this->doPost('/layout/copy/' . $this->layoutId, $this->toArray());
$this->getLogger()->debug('Passing the response to Hydrate');
$layout = $this->constructLayoutFromResponse($response);
return $layout;
} | [
"public",
"function",
"copy",
"(",
"$",
"name",
",",
"$",
"description",
",",
"$",
"copyMediaFiles",
")",
"{",
"$",
"this",
"->",
"name",
"=",
"$",
"name",
";",
"$",
"this",
"->",
"description",
"=",
"$",
"description",
";",
"$",
"this",
"->",
"copyM... | Copy the layout.
@param string $name Name of the copied layout
@param string $description Description of the copied layout
@param int $copyMediaFiles Flag indicating whether to make copies of all media files assigned to the layout being copied
@return XiboLayout | [
"Copy",
"the",
"layout",
"."
] | 8e6ddb4be070257233c225f8829b8117f9d978c3 | https://github.com/xibosignage/oauth2-xibo-cms/blob/8e6ddb4be070257233c225f8829b8117f9d978c3/src/Entity/XiboLayout.php#L316-L328 |
Subsets and Splits
Yii Code Samples
Gathers all records from test, train, and validation sets that contain the word 'yii', providing a basic filtered view of the dataset relevant to Yii-related content.