sentence1 stringlengths 52 3.87M | sentence2 stringlengths 1 47.2k | label stringclasses 1
value |
|---|---|---|
public function postUiOpenwindowContract($contractId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$this->postUiOpenwindowContractWithHttpInfo($contractId, $datasource, $token, $userAgent, $xUserAgent);
} | Operation postUiOpenwindowContract
Open Contract Window
@param int $contractId The contract to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgen... | entailment |
public function postUiOpenwindowContractAsync($contractId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postUiOpenwindowContractAsyncWithHttpInfo($contractId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($re... | Operation postUiOpenwindowContractAsync
Open Contract Window
@param int $contractId The contract to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $use... | entailment |
public function postUiOpenwindowContractAsyncWithHttpInfo($contractId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiOpenwindowContractRequest($contractId, $datasource, $token, $userAgent, $xUserAgent);
return ... | Operation postUiOpenwindowContractAsyncWithHttpInfo
Open Contract Window
@param int $contractId The contract to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param ... | entailment |
public function postUiOpenwindowInformation($targetId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$this->postUiOpenwindowInformationWithHttpInfo($targetId, $datasource, $token, $userAgent, $xUserAgent);
} | Operation postUiOpenwindowInformation
Open Information Window
@param int $targetId The target to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAg... | entailment |
public function postUiOpenwindowInformationAsync($targetId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postUiOpenwindowInformationAsyncWithHttpInfo($targetId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($... | Operation postUiOpenwindowInformationAsync
Open Information Window
@param int $targetId The target to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $u... | entailment |
public function postUiOpenwindowInformationAsyncWithHttpInfo($targetId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiOpenwindowInformationRequest($targetId, $datasource, $token, $userAgent, $xUserAgent);
retur... | Operation postUiOpenwindowInformationAsyncWithHttpInfo
Open Information Window
@param int $targetId The target to open (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@para... | entailment |
public function postUiOpenwindowMarketdetailsAsync($typeId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postUiOpenwindowMarketdetailsAsyncWithHttpInfo($typeId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($... | Operation postUiOpenwindowMarketdetailsAsync
Open Market Details
@param int $typeId The item type to open in market window (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@... | entailment |
public function postUiOpenwindowMarketdetailsAsyncWithHttpInfo($typeId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiOpenwindowMarketdetailsRequest($typeId, $datasource, $token, $userAgent, $xUserAgent);
retur... | Operation postUiOpenwindowMarketdetailsAsyncWithHttpInfo
Open Market Details
@param int $typeId The item type to open in market window (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header ... | entailment |
public function postUiOpenwindowNewmail($newMail, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$this->postUiOpenwindowNewmailWithHttpInfo($newMail, $datasource, $token, $userAgent, $xUserAgent);
} | Operation postUiOpenwindowNewmail
Open New Mail Window
@param \nullx27\ESI\nullx27\ESI\Models\PostUiOpenwindowNewmailNewMail $newMail The details of mail to create (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to u... | entailment |
public function postUiOpenwindowNewmailAsync($newMail, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postUiOpenwindowNewmailAsyncWithHttpInfo($newMail, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) ... | Operation postUiOpenwindowNewmailAsync
Open New Mail Window
@param \nullx27\ESI\nullx27\ESI\Models\PostUiOpenwindowNewmailNewMail $newMail The details of mail to create (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token... | entailment |
public function postUiOpenwindowNewmailAsyncWithHttpInfo($newMail, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiOpenwindowNewmailRequest($newMail, $datasource, $token, $userAgent, $xUserAgent);
return $this->c... | Operation postUiOpenwindowNewmailAsyncWithHttpInfo
Open New Mail Window
@param \nullx27\ESI\nullx27\ESI\Models\PostUiOpenwindowNewmailNewMail $newMail The details of mail to create (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token ... | entailment |
public function getWarsAsync($datasource = 'tranquility', $maxWarId = null, $userAgent = null, $xUserAgent = null)
{
return $this->getWarsAsyncWithHttpInfo($datasource, $maxWarId, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
... | Operation getWarsAsync
List wars
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $maxWarId Only return wars with ID smaller than this. (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUs... | entailment |
public function getWarsWarId($warId, $datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getWarsWarIdWithHttpInfo($warId, $datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getWarsWarId
Get war information
@param int $warId ID for a war (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifie... | entailment |
public function getWarsWarIdAsync($warId, $datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getWarsWarIdAsyncWithHttpInfo($warId, $datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
... | Operation getWarsWarIdAsync
Get war information
@param int $warId ID for a war (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client iden... | entailment |
public function getWarsWarIdKillmailsAsync($warId, $datasource = 'tranquility', $page = '1', $userAgent = null, $xUserAgent = null)
{
return $this->getWarsWarIdKillmailsAsyncWithHttpInfo($warId, $datasource, $page, $userAgent, $xUserAgent)
->then(
function ($response) {
... | Operation getWarsWarIdKillmailsAsync
List kills for a war
@param int $warId A valid war ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $page Which page of results to return (optional, default to 1)
@param string $userAgent Client iden... | entailment |
public function acquire($key)
{
$this->assertNotAcquired($key);
return $this->storage->save($key, $this->ttl);
} | {@inheritdoc} | entailment |
public function refresh($key)
{
$this->assertAcquired($key);
return $this->storage->save($key, $this->ttl);
} | {@inheritdoc} | entailment |
public function listInvalidProperties()
{
$invalidProperties = [];
if (!is_null($this->container['currentRank']) && ($this->container['currentRank'] > 9)) {
$invalidProperties[] = "invalid value for 'currentRank', must be smaller than or equal to 9.";
}
if (!is_null($th... | Show all the invalid properties with reasons.
@return array invalid properties with reasons | entailment |
public function setCurrentRank($currentRank)
{
if (!is_null($currentRank) && ($currentRank > 9)) {
throw new \InvalidArgumentException('invalid value for $currentRank when calling GetCharactersCharacterIdFwStatsOk., must be smaller than or equal to 9.');
}
if (!is_null($currentR... | Sets currentRank
@param int $currentRank The given character's current faction rank
@return $this | entailment |
public function setHighestRank($highestRank)
{
if (!is_null($highestRank) && ($highestRank > 9)) {
throw new \InvalidArgumentException('invalid value for $highestRank when calling GetCharactersCharacterIdFwStatsOk., must be smaller than or equal to 9.');
}
if (!is_null($highestR... | Sets highestRank
@param int $highestRank The given character's highest faction rank achieved
@return $this | entailment |
public function getMarketsGroupsMarketGroupId($marketGroupId, $datasource = null, $language = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getMarketsGroupsMarketGroupIdWithHttpInfo($marketGroupId, $datasource, $language, $userAgent, $xUserAgent);
return $response;
} | Operation getMarketsGroupsMarketGroupId
Get item group information
@param int $marketGroupId An Eve item group ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $language Language to use in the response (optional, default to en-us)
@param... | entailment |
public function getMarketsRegionIdHistory($regionId, $typeId, $datasource = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getMarketsRegionIdHistoryWithHttpInfo($regionId, $typeId, $datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getMarketsRegionIdHistory
List historical market statistics in a region
@param int $regionId Return statistics in this region (required)
@param int $typeId Return statistics for this type (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param ... | entailment |
public function getMarketsRegionIdOrders($orderType, $regionId, $datasource = null, $page = null, $typeId = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getMarketsRegionIdOrdersWithHttpInfo($orderType, $regionId, $datasource, $page, $typeId, $userAgent, $xUserAgent);
retur... | Operation getMarketsRegionIdOrders
List orders in a region
@param string $orderType Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. (required)
@param int $regionId Return orders in this region (required)
@param string $datasource The serve... | entailment |
public function getValidValue($intDynamicPosition = 0)
{
$varReturn = null;
if (isset($this->__validvalues[$intDynamicPosition])) {
$varReturn = $this->__validvalues[$intDynamicPosition];
}
return $varReturn;
} | Get the validated value
@param integer $intDynamicPosition
@return array|string | entailment |
public function getValue($intDynamicPosition = 0)
{
$varReturn = null;
if (isset($this->__overrideerrors[$intDynamicPosition]) && empty($this->__overrideerrors[$intDynamicPosition])) {
$varReturn = null;
} else {
$strFieldName = ($intDynamicPosition > 0) ? $this->__f... | Get the value to validate from either the global request variable or the cached __validvalues array.
@param integer $intDynamicPosition Using the intDynamicPosition parameter, you can get the specific value
of a dynamic field.
@return string|array|null Returns the submitted field value. If no sumitted value is set,
re... | entailment |
public function validate($intDynamicPosition = 0)
{
// Reset the internal errors array
$this->__errors = array();
// *** Get the value to validate from either the global request variable or the cached __validvalues array.
$value = $this->getValue($intDynamicPosition);
// **... | The most important function of ValidForm Builder library.
This function handles all the server-side field validation logic.
@param integer $intDynamicPosition Using the intDynamicPosition parameter, you can validate a specific dynamic
field, if necessary.
@return boolean True if the current field validates, false if n... | entailment |
public function getError($intDynamicPosition = 0)
{
$strReturn = "";
if (isset($this->__errors[$intDynamicPosition]) && !empty($this->__errors[$intDynamicPosition])) {
$strReturn = $this->__errors[$intDynamicPosition];
}
return $strReturn;
} | Get error message
@param integer $intDynamicPosition
@return string | entailment |
public function getCheck()
{
if (!empty($this->__validation)) {
$strReturn = $this->__validation;
} else {
$strReturn = Validator::getCheck($this->__field->getType());
}
return $strReturn;
} | Get the validation rule (regular expression)
@return string | entailment |
private function __hasError($intDynamicPosition = 0)
{
return (isset($this->__errors[$intDynamicPosition]) && ! empty($this->__errors[$intDynamicPosition]));
} | Check if an error has occured
@param integer $intDynamicPosition
@return boolean | entailment |
public static function checkCORS()
{
Logger::log('Checking CORS');
$corsEnabled = Config::getParam('cors.enabled');
$request = Request::getInstance();
if (NULL !== $corsEnabled) {
if ($corsEnabled === '*' || preg_match($corsEnabled, $request->getServer('HTTP_REFERER'))) {... | Check CROS requests | entailment |
public static function validateIpAddress($ipAddress) {
if (strtolower($ipAddress) === 'unknown') {
return false;
}
// generate ipv4 network address
$ipAddress = ip2long($ipAddress);
// if the ip is set and not equivalent to 255.255.255.255
if ($ipAddress !==... | Ensures an ip address is both a valid IP and does not fall within
a private network range. | entailment |
public function init()
{
Logger::log('Dispatcher init');
parent::init();
$this->initiateStats();
I18nHelper::setLocale();
$this->bindWarningAsExceptions();
$this->actualUri = Request::getInstance()->getServer('REQUEST_URI');
Logger::log('End dispatcher init');... | Initializer method | entailment |
public function run($uri = null)
{
Logger::log('Begin runner');
try {
if ($this->config->isConfigured()) {
//Check CORS for requests
RequestHelper::checkCORS();
if (!Request::getInstance()->isFile()) {
return $this->rout... | Run method
@param string $uri
@return string HTML | entailment |
protected function dumpException(\Exception $e)
{
Logger::log('Starting dump exception');
$ex = (NULL !== $e->getPrevious()) ? $e->getPrevious() : $e;
$error = array(
"error" => $ex->getMessage(),
"file" => $ex->getFile(),
"line" => $ex->getLine(),
... | Method that convert an exception to html
@param \Exception $e
@return string HTML | entailment |
public function getColorAllowableValues()
{
return [
self::COLOR_FFFFFF,
self::COLOR_FFFF01,
self::COLOR_FF6600,
self::COLOR_FE0000,
self::COLOR__9A0000,
self::COLOR__660066,
self::COLOR__0000FE,
self::COLOR__009... | Gets allowable values of the enum
@return string[] | entailment |
public function setColor($color)
{
$allowed_values = array('#ffffff', '#ffff01', '#ff6600', '#fe0000', '#9a0000', '#660066', '#0000fe', '#0099ff', '#01ffff', '#00ff33', '#349800', '#006634', '#666666', '#999999', '#e6e6e6', '#ffffcd', '#99ffff', '#ccff9a');
if (!is_null($color) && (!in_array($color,... | Sets color
@param string $color Hexadecimal string representing label color, in RGB format
@return $this | entailment |
public function contains(Address $address)
{
$addressValue = $address->get();
return $addressValue >= $this->firstAddress->get() && $addressValue <= $this->lastAddress->get();
} | Determine if a given address is contained within the range.
@param \JAAulde\IP\V4\Address $address The address we want to know about
@return bool | entailment |
public function setLinkLevel($linkLevel)
{
if (($linkLevel > 10)) {
throw new \InvalidArgumentException('invalid value for $linkLevel when calling GetCharactersCharacterIdPlanetsPlanetIdLink., must be smaller than or equal to 10.');
}
if (($linkLevel < 0)) {
throw ne... | Sets linkLevel
@param int $linkLevel link_level integer
@return $this | entailment |
public function getCharactersCharacterIdLocation($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdLocationWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
... | Operation getCharactersCharacterIdLocation
Get character location
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string... | entailment |
public function getCharactersCharacterIdLocationAsync($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdLocationAsyncWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent)
->then(
... | Operation getCharactersCharacterIdLocationAsync
Get character location
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param s... | entailment |
public function getCharactersCharacterIdOnline($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdOnlineWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCharactersCharacterIdOnline
Get character online
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $us... | entailment |
public function getCharactersCharacterIdOnlineAsync($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdOnlineAsyncWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent)
->then(
... | Operation getCharactersCharacterIdOnlineAsync
Get character online
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param strin... | entailment |
public function getCharactersCharacterIdShip($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdShipWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCharactersCharacterIdShip
Get current ship
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgen... | entailment |
public function getCharactersCharacterIdShipAsync($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdShipAsyncWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent)
->then(
fun... | Operation getCharactersCharacterIdShipAsync
Get current ship
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $use... | entailment |
public function getWars($datasource = null, $maxWarId = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getWarsWithHttpInfo($datasource, $maxWarId, $userAgent, $xUserAgent);
return $response;
} | Operation getWars
List wars
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $maxWarId Only return wars with ID smaller than this. (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent C... | entailment |
public function getWarsWarIdKillmails($warId, $datasource = null, $page = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getWarsWarIdKillmailsWithHttpInfo($warId, $datasource, $page, $userAgent, $xUserAgent);
return $response;
} | Operation getWarsWarIdKillmails
List kills for a war
@param int $warId A valid war ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $page Which page to query, starting at 1 (optional, default to 1)
@param string $userAgent Client identifier... | entailment |
public function logs()
{
$log = t("Selecciona un fichero de log");
$logs = $this->srv->getLogFiles();
asort($logs);
return $this->render("logs.html.twig", array(
"logs" => $logs,
"log" => $log,
));
} | Servicio que muestra los logs del sistema
@GET
@route /admin/logs
@label VIsor de logs del sistema
@visible false
@return string|null | entailment |
public function listInvalidProperties()
{
$invalid_properties = [];
if ($this->container['maxDockableShipVolume'] === null) {
$invalid_properties[] = "'maxDockableShipVolume' can't be null";
}
if ($this->container['name'] === null) {
$invalid_properties[] = "'... | show all the invalid properties with reasons.
@return array invalid properties with reasons | entailment |
public function valid()
{
if ($this->container['maxDockableShipVolume'] === null) {
return false;
}
if ($this->container['name'] === null) {
return false;
}
if ($this->container['officeRentalCost'] === null) {
return false;
}
... | validate all the properties in the model
return true if all passed
@return bool True if all properteis are valid | entailment |
public function setServices($services)
{
$allowed_values = array('bounty-missions', 'assasination-missions', 'courier-missions', 'interbus', 'reprocessing-plant', 'refinery', 'market', 'black-market', 'stock-exchange', 'cloning', 'surgery', 'dna-therapy', 'repair-facilities', 'factory', 'labratory', 'gambli... | Sets services
@param string[] $services services array
@return $this | entailment |
public function getCharactersCharacterIdPlanetsAsync($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdPlanetsAsyncWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent)
->then(
... | Operation getCharactersCharacterIdPlanetsAsync
Get colonies
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a header (optional)
@param string $user... | entailment |
public function getCharactersCharacterIdPlanetsPlanetId($characterId, $planetId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdPlanetsPlanetIdWithHttpInfo($characterId, $planetId, $datasource, $token, $userAgent, $xUserA... | Operation getCharactersCharacterIdPlanetsPlanetId
Get colony layout
@param int $characterId An EVE character ID (required)
@param int $planetId Planet id of the target planet (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Acces... | entailment |
public function getCharactersCharacterIdPlanetsPlanetIdAsync($characterId, $planetId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdPlanetsPlanetIdAsyncWithHttpInfo($characterId, $planetId, $datasource, $token, $userAgent, $xUserAg... | Operation getCharactersCharacterIdPlanetsPlanetIdAsync
Get colony layout
@param int $characterId An EVE character ID (required)
@param int $planetId Planet id of the target planet (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token ... | entailment |
public function getCorporationsCorporationIdCustomsOffices($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdCustomsOfficesWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent,... | Operation getCorporationsCorporationIdCustomsOffices
List corporation customs offices
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $page Which page of results to return (optional, default ... | entailment |
public function getCorporationsCorporationIdCustomsOfficesAsync($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdCustomsOfficesAsyncWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent, ... | Operation getCorporationsCorporationIdCustomsOfficesAsync
List corporation customs offices
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param int $page Which page of results to return (optional, def... | entailment |
public function getUniverseSchematicsSchematicId($schematicId, $datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getUniverseSchematicsSchematicIdWithHttpInfo($schematicId, $datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getUniverseSchematicsSchematicId
Get schematic information
@param int $schematicId A PI schematic ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param... | entailment |
public function getUniverseSchematicsSchematicIdAsync($schematicId, $datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getUniverseSchematicsSchematicIdAsyncWithHttpInfo($schematicId, $datasource, $userAgent, $xUserAgent)
->then(
function ($respons... | Operation getUniverseSchematicsSchematicIdAsync
Get schematic information
@param int $schematicId A PI schematic ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@... | entailment |
public function getCharactersCharacterIdFwStats($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdFwStatsWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCharactersCharacterIdFwStats
Overview of a character involved in faction warfare
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a head... | entailment |
public function getCharactersCharacterIdFwStatsAsync($characterId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdFwStatsAsyncWithHttpInfo($characterId, $datasource, $token, $userAgent, $xUserAgent)
->then(
... | Operation getCharactersCharacterIdFwStatsAsync
Overview of a character involved in faction warfare
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to set a... | entailment |
public function getCorporationsCorporationIdFwStats($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdFwStatsWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent);
return $res... | Operation getCorporationsCorporationIdFwStats
Overview of a corporation involved in faction warfare
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unable to ... | entailment |
public function getCorporationsCorporationIdFwStatsAsync($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdFwStatsAsyncWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent)
->then(
... | Operation getCorporationsCorporationIdFwStatsAsync
Overview of a corporation involved in faction warfare
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $token Access token to use if unabl... | entailment |
public function getFwLeaderboards($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwLeaderboardsWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwLeaderboards
List of the top factions in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes prece... | entailment |
public function getFwLeaderboardsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwLeaderboardsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
... | Operation getFwLeaderboardsAsync
List of the top factions in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes ... | entailment |
public function getFwLeaderboardsCharacters($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwLeaderboardsCharactersWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwLeaderboardsCharacters
List of the top pilots in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, tak... | entailment |
public function getFwLeaderboardsCharactersAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwLeaderboardsCharactersAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $respo... | Operation getFwLeaderboardsCharactersAsync
List of the top pilots in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier... | entailment |
public function getFwLeaderboardsCorporations($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwLeaderboardsCorporationsWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwLeaderboardsCorporations
List of the top corporations in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identif... | entailment |
public function getFwLeaderboardsCorporationsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwLeaderboardsCorporationsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $r... | Operation getFwLeaderboardsCorporationsAsync
List of the top corporations in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client id... | entailment |
public function getFwStats($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwStatsWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwStats
An overview of statistics about factions involved in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client ident... | entailment |
public function getFwStatsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwStatsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
... | Operation getFwStatsAsync
An overview of statistics about factions involved in faction warfare
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client ... | entailment |
public function getFwSystems($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwSystemsWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwSystems
Ownership of faction warfare systems
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over U... | entailment |
public function getFwSystemsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwSystemsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
... | Operation getFwSystemsAsync
Ownership of faction warfare systems
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence o... | entailment |
public function getFwWars($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getFwWarsWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getFwWars
Data about which NPC factions are at war
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over ... | entailment |
public function getFwWarsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getFwWarsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
... | Operation getFwWarsAsync
Data about which NPC factions are at war
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence ... | entailment |
public function setDefaults($arrDefaults = array())
{
if (is_array($arrDefaults)) {
$this->__defaults = $arrDefaults;
} else {
throw new \InvalidArgumentException(
"Invalid argument passed in to ValidForm->setDefaults(). Expected array got " .
... | Use an array to set default values on all the forms children.
The array's keys should be the form name to set the default value of, the value is the actual value
or values to set.
Example 1 - Basic defaults:
```php
//*** The form
$objCheck = $objForm->addField("cool", "Coolest PHP Library", ValidForm::VFORM_STRING);
... | entailment |
public function addHtml($html, $meta = array())
{
$objString = new StaticText($html, $meta);
$this->__elements->addObject($objString);
return $objString;
} | Injects a string in the form.
Use this to add an extra string in the form. For instance, you can create an input field like this:
```
Enter the amount: $ _____
```
In this example, we used StaticText to inject the dollar sign before our input field.
@param string $html The string or HTML code to inject
@param arr... | entailment |
public function addNavigation($meta = array())
{
$objNavigation = new Navigation($meta);
$this->__elements->addObject($objNavigation);
return $objNavigation;
} | Add 'navigation' to the form. By navigation we mean a 'navigation div' at the buttom of the form containing
the submit button. This method is optional for customization purposes -- navigation is created automatically.
@param array $meta Array with meta data. Only the "style" attribute is supported as for now.
@return \... | entailment |
public function addFieldset($header = null, $noteHeader = null, $noteBody = null, $meta = array())
{
$objFieldSet = new Fieldset($header, $noteHeader, $noteBody, $meta);
$this->__elements->addObject($objFieldSet);
return $objFieldSet;
} | Add a fieldset to the form field collection
Example:
```php
$objForm->addFieldset("Header for fieldset", "Note", "Cool fields contained by fieldset.");
```
@param string $header The header for this fieldset
@param string $noteHeader An optional header for the 'note' block on the side of this fieldset
@param string $no... | entailment |
public function addHiddenField($name, $type, $meta = array(), $blnJustRender = false)
{
$objField = new Hidden($name, $type, $meta);
if (! $blnJustRender) {
// *** Fieldset already defined?
$objFieldset = $this->__elements->getLast("ValidFormBuilder\\Fieldset");
... | Add a hidden input field to the form collection.
Hidden fields can be used for example to inject custom values in your post data and still have
them validated using ValidForm Builder.
@param string $name The hidden field's `name` attribute
@param string $type Define a validation type using one of the `ValidForm::VFOR... | entailment |
public static function renderField($name, $label, $type, $validationRules, $errorHandlers, $meta)
{
$objField = null;
switch ($type) {
case static::VFORM_STRING:
case static::VFORM_WORD:
case static::VFORM_EMAIL:
case static::VFORM_URL:
cas... | Use this utility method to only render \ValidFormBuilder\Element instances of the defined types.
Elements rendered with this method aren't added to the internal elements collection.
@param string $name The element's name
@param string $label The element's label
@param integer $type The element's validation type
@para... | entailment |
public function addField(
$name,
$label,
$type,
$validationRules = array(),
$errorHandlers = array(),
$meta = array(),
$blnJustRender = false
) {
$objField = static::renderField($name, $label, $type, $validationRules, $errorHandlers, $meta);
$... | Add a new element to the internal elements collection
*Example; add a text field*:
```php
$objForm->addField(
"first-name",
"First name",
ValidForm::VFORM_STRING,
array(
// Make this field required
"required" => true
),
array(
// Show this error to indicate this is an required field if no value is submitted
"required"... | entailment |
public function addParagraph($strBody, $strHeader = "", $meta = array())
{
$objParagraph = new Paragraph($strHeader, $strBody, $meta);
// *** Fieldset already defined?
$objFieldset = $this->__elements->getLast("ValidFormBuilder\\Fieldset");
if ($this->__elements->count() == 0 || ! i... | Adds a \ValidFormBuilder\Paragraph object to the internal elements collection.
This renders a paragraph inside the form. Formfields can be added before and after the paragraph.
**Example:**
```php
$objForm->addField("name", "Your Name", ValidForm::VFORM_STRING);
$objForm->addParagraph("Next, you should enter your las... | entailment |
public function addButton($strLabel, $arrMeta = array())
{
$objButton = new Button($strLabel, $arrMeta);
// *** Fieldset already defined?
$objFieldset = $this->__elements->getLast("ValidFormBuilder\\Fieldset");
if ($this->__elements->count() == 0 || ! is_object($objFieldset)) {
... | Adds a <button> element to the internal fields collection.
For an example; see {@link \ValidFormBuilder\Button}
@param string $strLabel The button's label
@param array $arrMeta The meta array
@return \ValidFormBuilder\Button | entailment |
public function addArea($label = null, $active = false, $name = null, $checked = false, $meta = array())
{
$objArea = new Area($label, $active, $name, $checked, $meta);
$objArea->setRequiredStyle($this->__requiredstyle);
// *** Fieldset already defined?
$objFieldset = $this->__elem... | Add an area to the internal elements collection.
See {@link \ValidFormBuilder\Area} for examples
@param string $label The title of this area
@param bool $active If `true`, the title has a checkbox which can enable or disable all child elements
@param string $name The ID of this area
@param bool $checked Use in combin... | entailment |
public function addMultiField($label = null, $meta = array())
{
$strName = (isset($meta["name"])) ? $meta["name"] : null;
$objField = new MultiField($label, $meta, $strName);
$objField->setRequiredStyle($this->__requiredstyle);
// *** Fieldset already defined?
$objFieldset ... | Create a Multifield element
Multifield elements allow you to combine multiple fields horizontally with one label.
For example, create a first name + last name field with label "Full name"
```php
$objMulti = $objForm->addMultifield("Full name");
// Note: when using addField on a multifield, we don't set a label!
$objM... | entailment |
public function toHtml($blnClientSide = true, $blnForceSubmitted = null, $strCustomJs = "")
{
$strOutput = "";
if ($blnClientSide) {
$strOutput .= $this->__toJS($strCustomJs);
}
$strClass = "validform";
if (is_array($this->__meta)) {
if (isset($this... | Generate HTML output - build form
@param bool $blnClientSide Render javascript code or not, defaults to true
@param bool $blnForceSubmitted This forces the form rendering as if the fields are submitted
@param string $strCustomJs Inject custom javascript to be executed while
initializing ValidForm Builder client-side.
... | entailment |
public function fieldsToHtml($blnForceSubmitted = false, &$blnNavigation = false)
{
$strReturn = "";
if (is_array($this->__defaults) && count($this->__defaults) > 0) {
$objFields = $this->getCachedFields();
foreach ($objFields as $objField) {
$strName = $objF... | This method generates HTML output for the current internal elements collection.
This method is mostly used internally in the library and it's therefore not recommended to use this except
for these rare occasions when you only want the rendered fields an not all the meta surrounding the fields
like the form tag, descri... | entailment |
public function elementsToJs($blnRawJs = false)
{
$strReturn = "";
$strJs = "";
// *** Loop through all form elements and get their javascript code.
foreach ($this->__elements as $element) {
$strJs .= $element->toJS();
}
// Indent javascript
$st... | Generate the Javascript output only for the fields and conditions.
This is particulary useful when using ValidForm Builder in combination with AJAX form handling. You can inject
new fields and field logic into an existing ValidForm and all validation will be handled by that "parent" form.
@param boolean $blnRawJs Ret... | entailment |
public function serialize($blnSubmittedValues = true)
{
// Validate & cache all values
$this->valuesAsHtml($blnSubmittedValues); // Especially dynamic counters need this!
return base64_encode(gzcompress(serialize($this)));
} | Serialize, compress and encode the entire form including it's values
@param boolean $blnSubmittedValues
Whether or not to include submitted values or only serialize default values.
@return String Base64 encoded, gzcompressed, serialized form. | entailment |
public function isSubmitted($blnForce = false)
{
if (ValidForm::get("vf__dispatch") == $this->__name || $blnForce) {
if ($this->__usecsrfprotection && !$blnForce) {
return CSRF::validate($_POST);
} else {
return true;
}
} else {
... | Check if the form is submitted by validating the value of the hidden
vf__dispatch field.
@param boolean $blnForce Fake isSubmitted to true to force field values.
@return boolean | entailment |
public function getCachedFields()
{
$objReturn = $this->__cachedfields;
if (is_null($objReturn)) {
$objReturn = $this->getFields();
}
return $objReturn;
} | Fetch a cached flat collection of form fields instead of making
an expensive getFields() call and looping through all elements
@return Collection | entailment |
public function getFields()
{
$objFields = new Collection();
foreach ($this->__elements as $objFieldset) {
if ($objFieldset->hasFields()) {
/* @var $objField Base */
foreach ($objFieldset->getFields() as $objField) {
if (is_object($obj... | Get a flat Collection of all internal elements.
This loops through all elements and adds each element and their children to a new Collection which will be
returned. This results in a flat Collection filled with ValidForm Builder elements.
@return \ValidFormBuilder\Collection | entailment |
public function getValidField($id)
{
$objReturn = null;
$objFields = $this->getFields();
foreach ($objFields as $objField) {
if ($objField->getId() == $id) {
$objReturn = $objField;
break;
}
}
if (is_null($objReturn)) ... | Get a valid field object.
This is about the most important method of ValidForm Builder. Use this to get a valid field after validation
to fetch it's validated value.
Example:
```php
$objForm = new ValidForm('example');
$objForm->addField('test', 'Test field', ValidForm::VFORM_STRING);
if ($objForm->isSubmitted() &&... | entailment |
public function getInvalidFields()
{
$objFields = $this->getFields();
$arrReturn = array();
foreach ($objFields as $objField) {
$arrTemp = array();
if (! $objField->isValid()) {
$arrTemp[$objField->getName()] = $objField->getValidator()->getError();
... | Get an associative array of invalid field names (the array's keys) and the error message (the values)
This method is very useful when using ValidForm Builder with AJAX empowered forms.
Example:
```php
//*** The basic form set-up
$objForm = new ValidForm('ajaxForm');
$objForm->addField(
'firstName',
'First name',
Val... | entailment |
public function valuesAsHtml($hideEmpty = false, $collection = null)
{
$strTable = "\t<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" class=\"validform\">\n";
$strTableOutput = "";
$collection = (!is_null($collection)) ? $collection : $this->__elements;
foreach ($collection ... | A utility method to parse an overview of the submitted values.
This generates a table with `label: value` pairs. The output of this function is mostly used in for example
e-mail bodies. When the contact form created with ValidForm Builder is submitted, you only have to e-mail
the results of `valuesAsHtml()`
@param bo... | entailment |
public function fieldsetAsHtml($objFieldset, &$strSet, $hideEmpty = false)
{
$strTableOutput = "";
// If this fieldset was rendered invisible due to conditions,
// don't show it on the valuesAsHtml overview either.
if (!$this->elementShouldDisplay($objFieldset)) {
... | Generates HTML output for all fieldsets and their children elements.
This method is hardly used in the public API. The only reason why this is a public method is to enable
customization through class extension.
@param Fieldset $objFieldset The Fieldset object to parse
@param string $strSet Previously generated HTML
@... | entailment |
protected function areaAsHtml($objField, $hideEmpty = false, $intDynamicCount = 0)
{
$strReturn = "";
$strSet = "";
// If this area was rendered invisible due to conditions,
// don't show it on the valuesAsHtml overview either.
$blnShouldDisplay = $this->elementShoul... | Generates HTML output for the given area object and its child elements
@param Area $objField The Area object to parse
@param boolean $hideEmpty Set to true to hide empty field values from the overview. Defaults to false.
@param integer $intDynamicCount The dynamic counter for the current area being parsed
@return stri... | entailment |
protected function multiFieldAsHtml($objField, $hideEmpty = false, $intDynamicCount = 0)
{
$strReturn = "";
// If this multi field was rendered invisible due to conditions,
// don't show it on the valuesAsHtml overview either.
if (!$this->elementShouldDisplay($objField)) {
... | Generates HTML output for the given MultiField object and its child elements
@param MultiField $objField The Area object to parse
@param boolean $hideEmpty Set to true to hide empty field values from the overview. Defaults to false.
@param integer $intDynamicCount The dynamic counter for the current MultiField being p... | entailment |
protected function fieldAsHtml($objField, $hideEmpty = false, $intDynamicCount = 0)
{
$strReturn = "";
$strLabel = $objField->getShortLabel(); // Passing 'true' gets the short label if available.
$varValue = ($intDynamicCount > 0) ? $objField->getValue($intDynamicCount) : $objField->getValu... | Generates HTML output for the given field object and its child elements
@param Element $objField The Element class-based object to parse
@param boolean $hideEmpty Set to true to hide empty field values from the overview. Defaults to false.
@param integer $intDynamicCount The dynamic counter for the current Element bei... | entailment |
public function generateId($intLength = 8)
{
$strChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
$strReturn = '';
srand((double) microtime() * 1000000);
for ($i = 1; $i <= $intLength; $i ++) {
$intNum = rand() % (strlen($strChars) - 1);
... | Generate a unique ID
@param integer $intLength ID length
@return string Generated ID | entailment |
public static function get($param, $replaceEmpty = "")
{
$strReturn = (isset($_REQUEST[$param])) ? $_REQUEST[$param] : "";
if (empty($strReturn) && !is_numeric($strReturn) && $strReturn !== 0) {
//*** Try PUT or DELETE.
$strReturn = static::getHttpBodyValue($param, "");
... | Read parameters from the `$_REQUEST` array and body string with an optional fallback value
@param string $param The parameter to read
@param string $replaceEmpty Optional replace value when parameter is not available or empty
@return string|array | entailment |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.