super-powers/src/e335dd61-c2f9-4536-8ed9-aec5edee0b26/code.php

74 lines
1.6 KiB
PHP
Raw Normal View History

2024-07-16 12:12:10 +00:00
<?php
/**
* @package Joomla.Component.Builder
*
* @created 4th September, 2022
* @author Llewellyn van der Merwe <https://dev.vdm.io>
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
2024-07-20 20:42:08 +00:00
namespace VDM\Joomla\Interfaces\Remote;
2024-07-16 12:12:10 +00:00
/**
* Set data based on global unique ids to remote system
*
* @since 3.2.2
*/
2024-07-20 20:42:08 +00:00
interface SetInterface
2024-07-16 12:12:10 +00:00
{
/**
* Set the current active table
*
* @param string $table The table that should be active
*
* @return self
* @since 3.2.2
*/
public function table(string $table): self;
2024-07-20 20:42:08 +00:00
/**
* Set the current active area
*
* @param string $area The area that should be active
*
* @return self
* @since 3.2.2
*/
public function area(string $area): self;
2024-07-16 12:12:10 +00:00
/**
* Set the settings path
*
* @param string $settingsPath The repository settings path
*
* @return self
* @since 3.2.2
*/
public function setSettingsPath(string $settingsPath): self;
/**
2024-07-20 20:42:08 +00:00
* Set the index settings path
2024-07-16 12:12:10 +00:00
*
2024-07-20 20:42:08 +00:00
* @param string $settingsIndexPath The repository index settings path
2024-07-16 12:12:10 +00:00
*
2024-07-20 20:42:08 +00:00
* @return self
2024-07-16 12:12:10 +00:00
* @since 3.2.2
*/
2024-07-20 20:42:08 +00:00
public function setIndexSettingsPath(string $settingsIndexPath): self;
2024-07-16 12:12:10 +00:00
/**
2024-07-20 20:42:08 +00:00
* Save items remotely
2024-07-16 12:12:10 +00:00
*
2024-07-20 20:42:08 +00:00
* @param array $guids The global unique id of the item
*
* @return bool
* @throws \Exception
2024-07-16 12:12:10 +00:00
* @since 3.2.2
*/
2024-07-20 20:42:08 +00:00
public function items(array $guids): bool;
2024-07-16 12:12:10 +00:00
}