sentence1
stringlengths 52
3.87M
| sentence2
stringlengths 1
47.2k
| label
stringclasses 1
value |
|---|---|---|
public function getCharactersCharacterIdContractsContractIdItemsAsync($characterId, $contractId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdContractsContractIdItemsAsyncWithHttpInfo($characterId, $contractId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCharactersCharacterIdContractsContractIdItemsAsync
Get contract items
@param int $characterId An EVE character ID (required)
@param int $contractId ID of a contract (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationsCorporationIdContracts($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdContractsWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationsCorporationIdContracts
Get coporation contracts
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationsCorporationIdContracts200Ok[] | entailment |
public function getCorporationsCorporationIdContractsAsync($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdContractsAsyncWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationsCorporationIdContractsAsync
Get coporation contracts
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationsCorporationIdContractsContractIdBids($contractId, $corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdContractsContractIdBidsWithHttpInfo($contractId, $corporationId, $datasource, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationsCorporationIdContractsContractIdBids
Get corporation contract bids
@param int $contractId ID of a contract (required)
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationsCorporationIdContractsContractIdBids200Ok[] | entailment |
public function getCorporationsCorporationIdContractsContractIdBidsAsync($contractId, $corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdContractsContractIdBidsAsyncWithHttpInfo($contractId, $corporationId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationsCorporationIdContractsContractIdBidsAsync
Get corporation contract bids
@param int $contractId ID of a contract (required)
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationsCorporationIdContractsContractIdItems($contractId, $corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdContractsContractIdItemsWithHttpInfo($contractId, $corporationId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationsCorporationIdContractsContractIdItems
Get corporation contract items
@param int $contractId ID of a contract (required)
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationsCorporationIdContractsContractIdItems200Ok[] | entailment |
public function getCorporationsCorporationIdContractsContractIdItemsAsync($contractId, $corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdContractsContractIdItemsAsyncWithHttpInfo($contractId, $corporationId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationsCorporationIdContractsContractIdItemsAsync
Get corporation contract items
@param int $contractId ID of a contract (required)
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
protected function setClass($type, &$meta)
{
switch ($type) {
case ValidForm::VFORM_STRING:
$this->setFieldMeta("class", "vf__string");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_WORD:
$this->setFieldMeta("class", "vf__word");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_EMAIL:
$this->setFieldMeta("class", "vf__email");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_URL:
case ValidForm::VFORM_SIMPLEURL:
$this->setFieldMeta("class", "vf__url");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_CUSTOM:
$this->setFieldMeta("class", "vf__custom");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_CURRENCY:
$this->setFieldMeta("class", "vf__currency");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_DATE:
$this->setFieldMeta("class", "vf__date");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_NUMERIC:
$this->setFieldMeta("class", "vf__numeric");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_INTEGER:
$this->setFieldMeta("class", "vf__integer");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_PASSWORD:
$this->setFieldMeta("class", "vf__password");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_HTML:
$this->setFieldMeta("class", "vf__html");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_CUSTOM_TEXT:
$this->setFieldMeta("class", "vf__custom");
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_TEXT:
$this->setFieldMeta("class", "vf__text");
break;
case ValidForm::VFORM_FILE:
$this->setFieldMeta("class", "vf__file");
break;
case ValidForm::VFORM_BOOLEAN:
$this->setFieldMeta("class", "vf__checkbox");
break;
case ValidForm::VFORM_RADIO_LIST:
case ValidForm::VFORM_CHECK_LIST:
$this->setFieldMeta("class", "vf__list");
break;
case ValidForm::VFORM_SELECT_LIST:
if (! isset($meta["multiple"])) {
$this->setFieldMeta("class", "vf__one");
} else {
$this->setFieldMeta("class", "vf__multiple");
}
$this->setFieldMeta("class", "vf__select");
break;
}
} | Set type class
@param integer $type
@param array $meta | entailment |
public function __toHtml($submitted = false, $blnSimpleLayout = false, $blnLabel = true, $blnDisplayErrors = true, $intCount = 0)
{
return $this->toHtml($submitted, $blnSimpleLayout, $blnLabel, $blnDisplayErrors);
} | Generate HTML output for specific dynamic count
@param boolean $submitted
@param boolean $blnSimpleLayout
@param boolean $blnLabel
@param boolean $blnDisplayErrors
@param integer $intCount
@return string | entailment |
public function getRandomId($name)
{
if (strpos($name, "[]") !== false) {
$strReturn = str_replace("[]", "_" . rand(100000, 900000), $name);
} else {
$strReturn = $name . "_" . rand(100000, 900000);
}
return $strReturn;
} | Generate a random ID for a given field name to prevent having two fields with the same name
@param string $name Field name
@return string | entailment |
public function isValid($intCount = null)
{
$blnReturn = false;
$intDynamicCount = $this->getDynamicCount();
if (is_null($intCount)) {
// No specific dynamic count is set, loop through dynamic fields internally
for ($intCount = 0; $intCount <= $intDynamicCount; $intCount ++) {
$blnReturn = $this->__validator->validate($intCount);
if (! $blnReturn) {
break;
}
}
} else {
// Validate just one, we're looping through the external fields externally
$blnReturn = $this->__validator->validate($intCount);
}
return $blnReturn;
} | Validate the current field.
This is a wrapper method to call the Validator->validate() method.
Although you could validate fields on a per-field basis with this method, this is mostly used internally.
For instance, when {@link \ValidFormBuilder\ValidForm::validate()} is called, it loops trough it's elements
collection and calls this method for each element it finds.
@see \ValidFormBuilder\Validator::validate()
@param null $intCount Optional. If set, only the dynamic field with this index will be validated.
@return bool True if field validates, false if not. | entailment |
public function getDynamicCount($blnParentIsDynamic = false)
{
$intReturn = 0;
if (($this->__dynamic || $blnParentIsDynamic) && is_object($this->__dynamiccounter)) {
$intReturn = $this->__dynamiccounter->getValidator()->getValue();
}
return (int) $intReturn;
} | Get the number of dynamic fields from the dynamic counter field.
@param bool $blnParentIsDynamic
@return integer The dynamic count of this field | entailment |
protected function getDynamicHtml()
{
$strReturn = "";
if ($this->__dynamic && ! empty($this->__dynamicLabel)) {
$strReturn = "<div class=\"vf__dynamic\"><a href=\"#\" data-target-id=\"{$this->__id}\" "
. "data-target-name=\"{$this->__name}\"{$this->__getDynamicLabelMetaString()}>"
. $this->__dynamicLabel . "</a></div>\n";
}
return $strReturn;
} | Render html element needed for dynamic duplication client-side
@return string | entailment |
public function getValue($intDynamicPosition = 0)
{
$varValue = null;
if ($intDynamicPosition > 0) {
$objValidator = $this->__validator;
$objValidator->validate($intDynamicPosition);
$varValue = $objValidator->getValidValue($intDynamicPosition);
} else {
$varValue = $this->__validator->getValidValue();
}
//*** Sanitize the value before returning.
$varValue = $this->sanitize($varValue, $this->__sanitize);
return $varValue;
} | Get the *valid* value of the current field.
@param integer $intDynamicPosition Optional parameter to get the value of a dynamic field.
@return mixed The valid value of this field. If validation fails, it returns null. | entailment |
protected function sanitize($varValue, $sanitizations)
{
if (is_array($sanitizations)) {
foreach ($sanitizations as $value) {
try {
if (is_string($value)) {
switch ($value) {
case "trim":
$varValue = trim($varValue);
break;
case "clear":
$varValue = "";
break;
}
} elseif (is_callable($value)) {
$varValue = $value($varValue);
}
} catch (\Exception $ex) {
//*** Sanitisation failed. Continue silently.
}
}
}
return $varValue;
} | Sanitize a value according to the order of actions in a sanitize array.
@param mixed $varValue
@param null|array $sanitizations
@return mixed|string | entailment |
public function setName($strName)
{
parent::setName($strName);
if (is_object($this->__validator)) {
$this->__validator->setFieldName($strName);
}
} | Set a new name for this element
This method also updates the name in the elements Validator instance.
@param string $strName The new name | entailment |
public function __getValue($submitted = false, $intDynamicPosition = 0)
{
$varReturn = null;
if ($submitted) {
if ($this->__validator->validate($intDynamicPosition)) {
$varReturn = $this->__validator->getValidValue($intDynamicPosition);
} else {
$varReturn = $this->__validator->getValue($intDynamicPosition);
}
} else {
if (is_array($this->__default)) {
if ($this->isDynamic()) {
if (isset($this->__default[$intDynamicPosition])
&& strlen($this->__default[$intDynamicPosition]) > 0) {
$varReturn = $this->__default[$intDynamicPosition];
}
} else {
$varReturn = $this->__default;
}
} else {
if (strlen($this->__default) > 0) {
$varReturn = $this->__default;
} elseif (strlen($this->__hint) > 0) {
$varReturn = $this->__hint;
}
}
}
if (! $varReturn && ((get_class($this) == "ValidFormBuilder\\Hidden") && $this->isDynamicCounter())) {
$varReturn = (int) 0;
}
//*** Sanitize the value before returning.
$varReturn = $this->sanitize($varReturn, $this->__displaySanitize);
return $varReturn;
} | Get the value of the field.
If the value is *valid* then it will return that value, otherwise the invalid value is returned.
@param boolean $submitted Indicate if the form is submitted.
@param integer $intDynamicPosition The position of the field in a dynamic field setup.
@return string|null | entailment |
public function valid()
{
$allowedValues = $this->getLocationTypeAllowableValues();
if (!in_array($this->container['locationType'], $allowedValues)) {
return false;
}
return true;
} | Validate all the properties in the model
return true if all passed
@return bool True if all properties are valid | entailment |
public function setLocationType($locationType)
{
$allowedValues = $this->getLocationTypeAllowableValues();
if (!is_null($locationType) && !in_array($locationType, $allowedValues)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'locationType', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['locationType'] = $locationType;
return $this;
} | Sets locationType
@param string $locationType location_type string
@return $this | entailment |
public function getEntityConfig(string $entity): array
{
if (!array_key_exists($entity, $this->configValues['entities'])) {
throw new \InvalidArgumentException("$entity is not set in config");
}
return $this->configValues['entities'][$entity];
} | Get config values for an entity
@param string $entity
@throws \InvalidArgumentException
@return array Config Values | entailment |
public static function findTranslations($path, $locale)
{
$localePath = realpath(BASE_DIR . DIRECTORY_SEPARATOR . 'locale');
$localePath .= DIRECTORY_SEPARATOR . $locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR;
$translations = array();
if (file_exists($path)) {
$d = dir($path);
while (false !== ($dir = $d->read())) {
GeneratorHelper::createDir($localePath);
if (!file_exists($localePath . 'translations.po')) {
file_put_contents($localePath . 'translations.po', '');
}
$inspect_path = realpath($path . DIRECTORY_SEPARATOR . $dir);
$cmd_php = "export PATH=\$PATH:/opt/local/bin; xgettext " .
$inspect_path . DIRECTORY_SEPARATOR .
"*.php --from-code=UTF-8 -j -L PHP --debug --force-po -o {$localePath}translations.po";
if (is_dir($path . DIRECTORY_SEPARATOR . $dir) && preg_match('/^\./', $dir) == 0) {
$res = t('Revisando directorio: ') . $inspect_path;
$res .= t('Comando ejecutado: ') . $cmd_php;
$res .= shell_exec($cmd_php);
usleep(10);
$translations[] = $res;
$translations = array_merge($translations, self::findTranslations($inspect_path, $locale));
}
}
}
return $translations;
} | Método que revisa las traducciones directorio a directorio
@param $path
@param $locale
@return array | entailment |
public function createStructureModule($module, $force = false, $type = "", $apiClass = "")
{
$mod_path = CORE_DIR . DIRECTORY_SEPARATOR;
$module = ucfirst($module);
$this->createModulePath($module, $mod_path);
$this->createModulePathTree($module, $mod_path);
$this->createModuleBaseFiles($module, $mod_path, $force, $type);
$this->createModuleModels($module, $mod_path);
$this->generateBaseApiTemplate($module, $mod_path, $force, $apiClass);
//Redireccionamos al home definido
$this->log->addLog("Módulo generado correctamente");
} | Servicio que genera la estructura de un módulo o lo actualiza en caso de ser necesario
@param string $module
@param boolean $force
@param string $type
@param string $apiClass
@return mixed | entailment |
private function createModulePath($module, $mod_path)
{
// Creates the src folder
GeneratorHelper::createDir($mod_path);
// Create module path
GeneratorHelper::createDir($mod_path . $module);
} | Service that creates the root paths for the modules
@param string $module
@param string $mod_path | entailment |
private function createModulePathTree($module, $mod_path)
{
//Creamos las carpetas CORE del módulo
$this->log->addLog("Generamos la estructura");
$paths = [
"Api", "Api/base", "Config", "Controller", "Models", "Public", "Templates", "Services", "Test", "Doc",
"Locale", "Locale/" . Config::getParam('default.locale', 'es_ES'), "Locale/" . Config::getParam('default.locale', 'es_ES') . "/LC_MESSAGES"
];
$module_path = $mod_path . $module;
foreach ($paths as $path) {
GeneratorHelper::createDir($module_path . DIRECTORY_SEPARATOR . $path);
}
//Creamos las carpetas de los assets
$htmlPaths = array("css", "js", "img", "media", "font");
foreach ($htmlPaths as $path) {
GeneratorHelper::createDir($module_path . DIRECTORY_SEPARATOR . "Public" . DIRECTORY_SEPARATOR . $path);
}
} | Servicio que genera la estructura base
@param string $module
@param boolean $mod_path
@return boolean | entailment |
private function createModuleBaseFiles($module, $mod_path, $force = false, $controllerType = '')
{
$module_path = $mod_path . $module;
$this->generateControllerTemplate($module, $module_path, $force, $controllerType);
$this->generateServiceTemplate($module, $module_path, $force);
$this->genereateAutoloaderTemplate($module, $module_path, $force);
$this->generateSchemaTemplate($module, $module_path, $force);
$this->generatePropertiesTemplate($module, $module_path, $force);
$this->generateConfigTemplate($module_path, $force);
$this->generateIndexTemplate($module, $module_path, $force);
$this->generatePublicTemplates($module_path, $force);
} | Servicio que genera las plantillas básicas de ficheros del módulo
@param string $module
@param string $mod_path
@param boolean $force
@param string $controllerType | entailment |
private function createModuleModels($module, $path)
{
$module_path = $path . $module;
$module_path = str_replace(CORE_DIR . DIRECTORY_SEPARATOR, '', $module_path);
$configGenerator = $this->getConfigGenerator($module_path);
$this->buildModels($configGenerator);
$this->buildSql($configGenerator);
$configTemplate = $this->tpl->dump("generator/config.propel.template.twig", array(
"module" => $module,
));
$this->writeTemplateToFile($configTemplate, CORE_DIR . DIRECTORY_SEPARATOR . $module_path . DIRECTORY_SEPARATOR . "Config" .
DIRECTORY_SEPARATOR . "config.php", true);
$this->log->addLog("Generado config genérico para propel");
} | Servicio que ejecuta Propel y genera el modelo de datos
@param string $module
@param string $path | entailment |
private function writeTemplateToFile($fileContent, $filename, $force = false)
{
$created = false;
if ($force || !file_exists($filename)) {
try {
$this->cache->storeData($filename, $fileContent, Cache::TEXT, true);
$created = true;
} catch (\Exception $e) {
Logger::log($e->getMessage(), LOG_ERR);
}
} else {
Logger::log($filename . t(' not exists or cant write'), LOG_ERR);
}
return $created;
} | Método que graba el contenido de una plantilla en un fichero
@param string $fileContent
@param string $filename
@param boolean $force
@return boolean | entailment |
private function createApiBaseFile($module, $mod_path, $api, $apiClass = '')
{
$class = preg_replace('/(\\\|\/)/', '', $module);
$customClass = GeneratorHelper::extractClassFromNamespace($apiClass);
$controller = $this->tpl->dump("generator/api.base.template.twig", array(
"module" => $module,
"api" => $api,
"namespace" => preg_replace('/(\\\|\/)/', '\\', $module),
"url" => preg_replace('/(\\\|\/)/', '/', $module),
"class" => $class,
'customClass' => $customClass,
'customNamespace' => $apiClass,
));
return $this->writeTemplateToFile($controller,
$mod_path . DIRECTORY_SEPARATOR . 'base' . DIRECTORY_SEPARATOR . "{$api}BaseApi.php", true);
} | Create ApiBase
@param string $module
@param string $mod_path
@param string $api
@param string $apiClass
@return bool | entailment |
private function createApi($module, $mod_path, $force, $api)
{
$class = preg_replace('/(\\\|\/)/', '', $module);
$controller = $this->tpl->dump("generator/api.template.twig", array(
"module" => $module,
"api" => $api,
"namespace" => preg_replace('/(\\\|\/)/', '\\', $module),
"url" => preg_replace('/(\\\|\/)/', '/', $module),
"class" => $class,
));
return $this->writeTemplateToFile($controller, $mod_path . DIRECTORY_SEPARATOR . "{$api}.php", $force);
} | Create Api
@param string $module
@param string $mod_path
@param bool $force
@param string $api
@return bool | entailment |
public static function copyResources($dest, $force, $filename_path, $debug)
{
if (file_exists($filename_path)) {
$destfolder = basename($filename_path);
if (!file_exists(WEB_DIR . $dest . DIRECTORY_SEPARATOR . $destfolder) || $debug || $force) {
if (is_dir($filename_path)) {
self::copyr($filename_path, WEB_DIR . $dest . DIRECTORY_SEPARATOR . $destfolder);
} else {
if (@copy($filename_path, WEB_DIR . $dest . DIRECTORY_SEPARATOR . $destfolder) === FALSE) {
throw new ConfigException("Can't copy " . $filename_path . " to " . WEB_DIR . $dest . DIRECTORY_SEPARATOR . $destfolder);
}
}
}
}
} | Method that copy resources recursively
@param string $dest
@param boolean $force
@param $filename_path
@param boolean $debug | entailment |
public static function copyr($src, $dst)
{
$dir = opendir($src);
GeneratorHelper::createDir($dst);
while (false !== ($file = readdir($dir))) {
if (($file != '.') && ($file != '..')) {
if (is_dir($src . '/' . $file)) {
self::copyr($src . '/' . $file, $dst . '/' . $file);
} elseif (@copy($src . '/' . $file, $dst . '/' . $file) === false) {
throw new ConfigException("Can't copy " . $src . " to " . $dst);
}
}
}
closedir($dir);
} | Method that copy a resource
@param string $src
@param string $dst
@throws ConfigException | entailment |
public function getLocationFlagAllowableValues()
{
return [
self::LOCATION_FLAG_ASSET_SAFETY,
self::LOCATION_FLAG_AUTO_FIT,
self::LOCATION_FLAG_BONUS,
self::LOCATION_FLAG_BOOSTER,
self::LOCATION_FLAG_BOOSTER_BAY,
self::LOCATION_FLAG_CAPSULE,
self::LOCATION_FLAG_CARGO,
self::LOCATION_FLAG_CORP_DELIVERIES,
self::LOCATION_FLAG_CORP_SAG1,
self::LOCATION_FLAG_CORP_SAG2,
self::LOCATION_FLAG_CORP_SAG3,
self::LOCATION_FLAG_CORP_SAG4,
self::LOCATION_FLAG_CORP_SAG5,
self::LOCATION_FLAG_CORP_SAG6,
self::LOCATION_FLAG_CORP_SAG7,
self::LOCATION_FLAG_CRATE_LOOT,
self::LOCATION_FLAG_DELIVERIES,
self::LOCATION_FLAG_DRONE_BAY,
self::LOCATION_FLAG_DUST_BATTLE,
self::LOCATION_FLAG_DUST_DATABANK,
self::LOCATION_FLAG_FIGHTER_BAY,
self::LOCATION_FLAG_FIGHTER_TUBE0,
self::LOCATION_FLAG_FIGHTER_TUBE1,
self::LOCATION_FLAG_FIGHTER_TUBE2,
self::LOCATION_FLAG_FIGHTER_TUBE3,
self::LOCATION_FLAG_FIGHTER_TUBE4,
self::LOCATION_FLAG_FLEET_HANGAR,
self::LOCATION_FLAG_HANGAR,
self::LOCATION_FLAG_HANGAR_ALL,
self::LOCATION_FLAG_HI_SLOT0,
self::LOCATION_FLAG_HI_SLOT1,
self::LOCATION_FLAG_HI_SLOT2,
self::LOCATION_FLAG_HI_SLOT3,
self::LOCATION_FLAG_HI_SLOT4,
self::LOCATION_FLAG_HI_SLOT5,
self::LOCATION_FLAG_HI_SLOT6,
self::LOCATION_FLAG_HI_SLOT7,
self::LOCATION_FLAG_HIDDEN_MODIFERS,
self::LOCATION_FLAG_IMPLANT,
self::LOCATION_FLAG_IMPOUNDED,
self::LOCATION_FLAG_JUNKYARD_REPROCESSED,
self::LOCATION_FLAG_JUNKYARD_TRASHED,
self::LOCATION_FLAG_LO_SLOT0,
self::LOCATION_FLAG_LO_SLOT1,
self::LOCATION_FLAG_LO_SLOT2,
self::LOCATION_FLAG_LO_SLOT3,
self::LOCATION_FLAG_LO_SLOT4,
self::LOCATION_FLAG_LO_SLOT5,
self::LOCATION_FLAG_LO_SLOT6,
self::LOCATION_FLAG_LO_SLOT7,
self::LOCATION_FLAG_LOCKED,
self::LOCATION_FLAG_MED_SLOT0,
self::LOCATION_FLAG_MED_SLOT1,
self::LOCATION_FLAG_MED_SLOT2,
self::LOCATION_FLAG_MED_SLOT3,
self::LOCATION_FLAG_MED_SLOT4,
self::LOCATION_FLAG_MED_SLOT5,
self::LOCATION_FLAG_MED_SLOT6,
self::LOCATION_FLAG_MED_SLOT7,
self::LOCATION_FLAG_OFFICE_FOLDER,
self::LOCATION_FLAG_PILOT,
self::LOCATION_FLAG_PLANET_SURFACE,
self::LOCATION_FLAG_QUAFE_BAY,
self::LOCATION_FLAG_REWARD,
self::LOCATION_FLAG_RIG_SLOT0,
self::LOCATION_FLAG_RIG_SLOT1,
self::LOCATION_FLAG_RIG_SLOT2,
self::LOCATION_FLAG_RIG_SLOT3,
self::LOCATION_FLAG_RIG_SLOT4,
self::LOCATION_FLAG_RIG_SLOT5,
self::LOCATION_FLAG_RIG_SLOT6,
self::LOCATION_FLAG_RIG_SLOT7,
self::LOCATION_FLAG_SECONDARY_STORAGE,
self::LOCATION_FLAG_SERVICE_SLOT0,
self::LOCATION_FLAG_SERVICE_SLOT1,
self::LOCATION_FLAG_SERVICE_SLOT2,
self::LOCATION_FLAG_SERVICE_SLOT3,
self::LOCATION_FLAG_SERVICE_SLOT4,
self::LOCATION_FLAG_SERVICE_SLOT5,
self::LOCATION_FLAG_SERVICE_SLOT6,
self::LOCATION_FLAG_SERVICE_SLOT7,
self::LOCATION_FLAG_SHIP_HANGAR,
self::LOCATION_FLAG_SHIP_OFFLINE,
self::LOCATION_FLAG_SKILL,
self::LOCATION_FLAG_SKILL_IN_TRAINING,
self::LOCATION_FLAG_SPECIALIZED_AMMO_HOLD,
self::LOCATION_FLAG_SPECIALIZED_COMMAND_CENTER_HOLD,
self::LOCATION_FLAG_SPECIALIZED_FUEL_BAY,
self::LOCATION_FLAG_SPECIALIZED_GAS_HOLD,
self::LOCATION_FLAG_SPECIALIZED_INDUSTRIAL_SHIP_HOLD,
self::LOCATION_FLAG_SPECIALIZED_LARGE_SHIP_HOLD,
self::LOCATION_FLAG_SPECIALIZED_MATERIAL_BAY,
self::LOCATION_FLAG_SPECIALIZED_MEDIUM_SHIP_HOLD,
self::LOCATION_FLAG_SPECIALIZED_MINERAL_HOLD,
self::LOCATION_FLAG_SPECIALIZED_ORE_HOLD,
self::LOCATION_FLAG_SPECIALIZED_PLANETARY_COMMODITIES_HOLD,
self::LOCATION_FLAG_SPECIALIZED_SALVAGE_HOLD,
self::LOCATION_FLAG_SPECIALIZED_SHIP_HOLD,
self::LOCATION_FLAG_SPECIALIZED_SMALL_SHIP_HOLD,
self::LOCATION_FLAG_STRUCTURE_ACTIVE,
self::LOCATION_FLAG_STRUCTURE_FUEL,
self::LOCATION_FLAG_STRUCTURE_INACTIVE,
self::LOCATION_FLAG_STRUCTURE_OFFLINE,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT0,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT1,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT2,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT3,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT4,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT5,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT6,
self::LOCATION_FLAG_SUB_SYSTEM_SLOT7,
self::LOCATION_FLAG_SUBSYSTEM_BAY,
self::LOCATION_FLAG_UNLOCKED,
self::LOCATION_FLAG_WALLET,
self::LOCATION_FLAG_WARDROBE,
];
} | Gets allowable values of the enum
@return string[] | entailment |
public function setLocationFlag($locationFlag)
{
$allowedValues = $this->getLocationFlagAllowableValues();
if (!in_array($locationFlag, $allowedValues)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'locationFlag', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['locationFlag'] = $locationFlag;
return $this;
} | Sets locationFlag
@param string $locationFlag Type of the location_id
@return $this | entailment |
public function setTimeEfficiency($timeEfficiency)
{
if (($timeEfficiency > 20)) {
throw new \InvalidArgumentException('invalid value for $timeEfficiency when calling GetCorporationsCorporationIdBlueprints200Ok., must be smaller than or equal to 20.');
}
if (($timeEfficiency < 0)) {
throw new \InvalidArgumentException('invalid value for $timeEfficiency when calling GetCorporationsCorporationIdBlueprints200Ok., must be bigger than or equal to 0.');
}
$this->container['timeEfficiency'] = $timeEfficiency;
return $this;
} | Sets timeEfficiency
@param int $timeEfficiency Time Efficiency Level of the blueprint.
@return $this | entailment |
public function setMaterialEfficiency($materialEfficiency)
{
if (($materialEfficiency > 25)) {
throw new \InvalidArgumentException('invalid value for $materialEfficiency when calling GetCorporationsCorporationIdBlueprints200Ok., must be smaller than or equal to 25.');
}
if (($materialEfficiency < 0)) {
throw new \InvalidArgumentException('invalid value for $materialEfficiency when calling GetCorporationsCorporationIdBlueprints200Ok., must be bigger than or equal to 0.');
}
$this->container['materialEfficiency'] = $materialEfficiency;
return $this;
} | Sets materialEfficiency
@param int $materialEfficiency Material Efficiency Level of the blueprint.
@return $this | entailment |
public function encode($data)
{
$data['exp'] = time() + $this->lifeTime;
return JWT::encode($data, $this->secretKey);
} | Encoded data
@param mixed $data
@return string | entailment |
public function decode($token)
{
try {
$data = JWT::decode($token, $this->secretKey, $this->allowed_algs);
} catch (\UnexpectedValueException $e) {
throw new \UnexpectedValueException($e->getMessage());
} catch (\DomainException $e) {
throw new \UnexpectedValueException($e->getMessage());
}
if ($data->exp < time()) {
throw new \UnexpectedValueException('token not allowed');
}
return $data;
} | Token for decoding
@param string $token
@return array
@throws AccessDeniedException | entailment |
public function toJS($intDynamicPosition = 0)
{
$strOutput = "";
$strCheck = $this->__sanitizeCheckForJs($this->__validator->getCheck());
$strRequired = ($this->__validator->getRequired()) ? "true" : "false";
$intMaxLength = ($this->__validator->getMaxLength() > 0) ? $this->__validator->getMaxLength() : "null";
$intMinLength = ($this->__validator->getMinLength() > 0) ? $this->__validator->getMinLength() : "null";
if ($this->__dynamic || $intDynamicPosition) {
$intDynamicCount = $this->getDynamicCount($intDynamicPosition);
for ($intCount = 0; $intCount <= $intDynamicCount; $intCount ++) {
$strId = ($intCount == 0) ? $this->__id : $this->__id . "_" . $intCount;
$strName = ($intCount == 0) ? $this->__name : $this->__name . "_" . $intCount;
// *** We asume that all dynamic fields greater than 0 are never required.
if ($intDynamicCount > 0) {
$strRequired = "false";
}
$strOutput .= "objForm.addElement('{$strId}', '{$strName}', {$strCheck}, {$strRequired}, {$intMaxLength}, {$intMinLength}, '" . addslashes($this->__validator->getFieldHint()) . "', '" . addslashes($this->__validator->getTypeError()) . "', '" . addslashes($this->__validator->getRequiredError()) . "', '" . addslashes($this->__validator->getHintError()) . "', '" . addslashes($this->__validator->getMinLengthError()) . "', '" . addslashes($this->__validator->getMaxLengthError()) . "');\n";
// *** Render the condition logic per dynamic field.
$strOutput .= $this->conditionsToJs($intCount);
}
} else {
$strOutput = "objForm.addElement('{$this->__id}', '{$this->__name}', {$strCheck}, {$strRequired}, {$intMaxLength}, {$intMinLength}, '" . addslashes($this->__validator->getFieldHint()) . "', '" . addslashes($this->__validator->getTypeError()) . "', '" . addslashes($this->__validator->getRequiredError()) . "', '" . addslashes($this->__validator->getHintError()) . "', '" . addslashes($this->__validator->getMinLengthError()) . "', '" . addslashes($this->__validator->getMaxLengthError()) . "');\n";
// *** Condition logic.
$strOutput .= $this->conditionsToJs();
}
return $strOutput;
} | Render javascript
@see \ValidFormBuilder\Element::toJS() | entailment |
public function getPlanetTypeAllowableValues()
{
return [
self::PLANET_TYPE_TEMPERATE,
self::PLANET_TYPE_BARREN,
self::PLANET_TYPE_OCEANIC,
self::PLANET_TYPE_ICE,
self::PLANET_TYPE_GAS,
self::PLANET_TYPE_LAVA,
self::PLANET_TYPE_STORM,
self::PLANET_TYPE_PLASMA,
];
} | Gets allowable values of the enum
@return string[] | entailment |
public function setUpgradeLevel($upgradeLevel)
{
if (($upgradeLevel > 5)) {
throw new \InvalidArgumentException('invalid value for $upgradeLevel when calling GetCharactersCharacterIdPlanets200Ok., must be smaller than or equal to 5.');
}
if (($upgradeLevel < 0)) {
throw new \InvalidArgumentException('invalid value for $upgradeLevel when calling GetCharactersCharacterIdPlanets200Ok., must be bigger than or equal to 0.');
}
$this->container['upgradeLevel'] = $upgradeLevel;
return $this;
} | Sets upgradeLevel
@param int $upgradeLevel upgrade_level integer
@return $this | entailment |
public function setPlanetType($planetType)
{
$allowedValues = $this->getPlanetTypeAllowableValues();
if (!in_array($planetType, $allowedValues)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'planetType', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['planetType'] = $planetType;
return $this;
} | Sets planetType
@param string $planetType planet_type string
@return $this | entailment |
public function removeOrder($fieldToRemove)
{
$order = array();
if (count($order) > 0) {
foreach ($this->fields as $field => $direction) {
if (strtolower($fieldToRemove) === strtolower($field)) {
continue;
}
$order[$field] = $direction;
}
}
$this->fields = $order;
} | Remove existing order
@param string $fieldToRemove | entailment |
public static function parseDirection($direction = Order::ASC)
{
if (preg_match('/^asc$/i', $direction)) {
return Order::ASC;
} else {
return Order::DESC;
}
} | Parse direction string
@param string $direction
@return string | entailment |
public function setAccessorType($accessorType)
{
$allowed_values = array('character', 'corporation', 'alliance');
if ((!in_array($accessorType, $allowed_values))) {
throw new \InvalidArgumentException("Invalid value for 'accessorType', must be one of 'character', 'corporation', 'alliance'");
}
$this->container['accessorType'] = $accessorType;
return $this;
} | Sets accessorType
@param string $accessorType accessor_type string
@return $this | entailment |
public function setOrder($order)
{
if (($order > 5)) {
throw new \InvalidArgumentException('invalid value for $order when calling GetCharactersCharacterIdPlanetsPlanetIdWaypoint., must be smaller than or equal to 5.');
}
if (($order < 1)) {
throw new \InvalidArgumentException('invalid value for $order when calling GetCharactersCharacterIdPlanetsPlanetIdWaypoint., must be bigger than or equal to 1.');
}
$this->container['order'] = $order;
return $this;
} | Sets order
@param int $order order integer
@return $this | entailment |
public function toHtml($submitted = false, $blnSimpleLayout = false, $blnLabel = true, $blnDisplayError = true)
{
$strOutput = "";
$this->setConditionalMeta();
$strValue = $this->__getValue($submitted);
$strValue = htmlspecialchars($strValue, ENT_QUOTES);
$strOutput .= "<input type=\"hidden\" value=\"{$strValue}\" name=\"{$this->__name}\" id=\"{$this->__id}\" {$this->__getFieldMetaString()} />\n";
return $strOutput;
} | Generate HTML
See {@link \ValidFormBuilder\Element::toHtml()}
@see \ValidFormBuilder\Element::toHtml() | entailment |
public function isValid($intCount = null)
{
$blnReturn = false;
$intDynamicCount = ($this->isDynamicCounter()) ? $this->__validator->getValue() : 0;
for ($intCount = 0; $intCount <= $intDynamicCount; $intCount ++) {
$blnReturn = $this->__validator->validate($intCount);
if (! $blnReturn) {
break;
}
}
return $blnReturn;
} | Validate this field
See {@link \ValidFormBuilder\Element::isValid()}
@see \ValidFormBuilder\Element::isValid() | entailment |
public function getCharactersCharacterIdIndustryJobs($characterId, $datasource = 'tranquility', $includeCompleted = null, $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdIndustryJobsWithHttpInfo($characterId, $datasource, $includeCompleted, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCharactersCharacterIdIndustryJobs
List character industry jobs
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param bool $includeCompleted Whether retrieve completed character industry jobs as well (optional)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdIndustryJobs200Ok[] | entailment |
public function getCharactersCharacterIdIndustryJobsAsync($characterId, $datasource = 'tranquility', $includeCompleted = null, $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdIndustryJobsAsyncWithHttpInfo($characterId, $datasource, $includeCompleted, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCharactersCharacterIdIndustryJobsAsync
List character industry jobs
@param int $characterId An EVE character ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param bool $includeCompleted Whether retrieve completed character industry jobs as well (optional)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCharactersCharacterIdMining($characterId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCharactersCharacterIdMiningWithHttpInfo($characterId, $datasource, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCharactersCharacterIdMining
Character mining ledger
@param int $characterId An EVE character 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 $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMining200Ok[] | entailment |
public function getCharactersCharacterIdMiningAsync($characterId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdMiningAsyncWithHttpInfo($characterId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCharactersCharacterIdMiningAsync
Character mining ledger
@param int $characterId An EVE character 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 $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationCorporationIdMiningExtractions($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationCorporationIdMiningExtractionsWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationCorporationIdMiningExtractions
Moon extraction timers
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationCorporationIdMiningExtractions200Ok[] | entailment |
public function getCorporationCorporationIdMiningExtractionsAsync($corporationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationCorporationIdMiningExtractionsAsyncWithHttpInfo($corporationId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationCorporationIdMiningExtractionsAsync
Moon extraction timers
@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 set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationCorporationIdMiningObservers($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationCorporationIdMiningObserversWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationCorporationIdMiningObservers
Corporation mining observers
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationCorporationIdMiningObservers200Ok[] | entailment |
public function getCorporationCorporationIdMiningObserversAsync($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationCorporationIdMiningObserversAsyncWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationCorporationIdMiningObserversAsync
Corporation mining observers
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationCorporationIdMiningObserversObserverId($corporationId, $observerId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationCorporationIdMiningObserversObserverIdWithHttpInfo($corporationId, $observerId, $datasource, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationCorporationIdMiningObserversObserverId
Observed corporation mining
@param int $corporationId An EVE corporation ID (required)
@param int $observerId A mining observer 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 $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationCorporationIdMiningObserversObserverId200Ok[] | entailment |
public function getCorporationCorporationIdMiningObserversObserverIdAsync($corporationId, $observerId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationCorporationIdMiningObserversObserverIdAsyncWithHttpInfo($corporationId, $observerId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationCorporationIdMiningObserversObserverIdAsync
Observed corporation mining
@param int $corporationId An EVE corporation ID (required)
@param int $observerId A mining observer 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 $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationsCorporationIdIndustryJobs($corporationId, $datasource = 'tranquility', $includeCompleted = 'false', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdIndustryJobsWithHttpInfo($corporationId, $datasource, $includeCompleted, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationsCorporationIdIndustryJobs
List corporation industry jobs
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param bool $includeCompleted Whether retrieve completed industry jobs as well (optional, default to false)
@param int $page Which page of results to return (optional, default to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationsCorporationIdIndustryJobs200Ok[] | entailment |
public function getCorporationsCorporationIdIndustryJobsAsync($corporationId, $datasource = 'tranquility', $includeCompleted = 'false', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdIndustryJobsAsyncWithHttpInfo($corporationId, $datasource, $includeCompleted, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationsCorporationIdIndustryJobsAsync
List corporation industry jobs
@param int $corporationId An EVE corporation ID (required)
@param string $datasource The server name you would like data from (optional, default to tranquility)
@param bool $includeCompleted Whether retrieve completed industry jobs as well (optional, default to false)
@param int $page Which page of results to return (optional, default to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getIndustryFacilities($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getIndustryFacilitiesWithHttpInfo($datasource, $userAgent, $xUserAgent);
return $response;
} | Operation getIndustryFacilities
List industry facilities
@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 User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetIndustryFacilities200Ok[] | entailment |
public function getIndustryFacilitiesAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getIndustryFacilitiesAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getIndustryFacilitiesAsync
List industry facilities
@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 User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getIndustrySystemsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getIndustrySystemsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getIndustrySystemsAsync
List solar system cost indices
@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 User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCategoryAllowableValues()
{
return [
self::CATEGORY_ALLIANCE,
self::CATEGORY_CHARACTER,
self::CATEGORY_CONSTELLATION,
self::CATEGORY_CORPORATION,
self::CATEGORY_INVENTORY_TYPE,
self::CATEGORY_REGION,
self::CATEGORY_SOLAR_SYSTEM,
self::CATEGORY_STATION,
];
} | Gets allowable values of the enum
@return string[] | entailment |
public function setCategory($category)
{
$allowed_values = array('alliance', 'character', 'constellation', 'corporation', 'inventory_type', 'region', 'solar_system', 'station');
if ((!in_array($category, $allowed_values))) {
throw new \InvalidArgumentException("Invalid value for 'category', must be one of 'alliance', 'character', 'constellation', 'corporation', 'inventory_type', 'region', 'solar_system', 'station'");
}
$this->container['category'] = $category;
return $this;
} | Sets category
@param string $category category string
@return $this | entailment |
public static function checkAndLoad(string $filename): string
{
$includePathFilename = \stream_resolve_include_path($filename);
// As a fallback, PHP looks in the directory of the file executing the stream_resolve_include_path function.
// We don't want to load the Test.php file here, so skip it if it found that.
// PHP prioritizes the include_path setting, so if the current directory is in there, it will first look in the
// current working directory.
$localFile = __DIR__ . DIRECTORY_SEPARATOR . $filename;
$isReadable = @\fopen($includePathFilename, 'r') !== false;
if (!$includePathFilename || !$isReadable || $includePathFilename === $localFile) {
throw new \Exception(\sprintf('Cannot open file "%s".' . "\n", $filename));
}
require_once $includePathFilename;
return $includePathFilename;
} | Checks if a PHP source file is readable and loads it.
@param string $filename
@return string
@throws \Exception | entailment |
public function postUiAutopilotWaypoint($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource = null, $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postUiAutopilotWaypointWithHttpInfo($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postUiAutopilotWaypoint
Set Autopilot Waypoint
@param bool $addToBeginning Whether this solar system should be added to the beginning of all waypoints (required)
@param bool $clearOtherWaypoints Whether clean other waypoints beforing adding this one (required)
@param int $destinationId The destination to travel to, can be solar system, station or structure's 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 preferred over a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@return void | entailment |
public function postUiOpenwindowMarketdetails($typeId, $datasource = null, $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postUiOpenwindowMarketdetailsWithHttpInfo($typeId, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postUiOpenwindowMarketdetails
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 preferred over a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@return void | entailment |
public function getIncursionsAsync($datasource = 'tranquility', $userAgent = null, $xUserAgent = null)
{
return $this->getIncursionsAsyncWithHttpInfo($datasource, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getIncursionsAsync
List incursions
@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 User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function addObject($value, $blnAddToBeginning = false)
{
if ($blnAddToBeginning) {
array_unshift($this->collection, $value);
} else {
array_push($this->collection, $value);
}
} | Add object to the collection
@param object $value The object
@param boolean $blnAddToBeginning Add object to beginning of array or not | entailment |
public function addObjectAtPosition($value, $intPosition)
{
$arrTempCollection = array();
$intCount = 0;
if ($intPosition >= $this->count()) {
// *** Position is greater than the collection count. Just add at the end.
$this->addObject($value);
} else {
foreach ($this->collection as $varObject) {
if ($intCount == $intPosition) {
// *** Insert the new object.
array_push($arrTempCollection, $value);
}
// *** Insert the existing object.
array_push($arrTempCollection, $varObject);
$intCount ++;
}
// *** Replace the collection.
$this->collection = $arrTempCollection;
}
} | Add object to the collection at a specified position
@param object $value The object
@param integer $intPosition The position the object should be placed at. | entailment |
public function addObjects($arrObjects, $blnAddToBeginning = false)
{
foreach ($arrObjects as $varObject) {
$this->addObject($varObject, $blnAddToBeginning);
}
} | Add objects to the collection
@param array $arrObjects An array of items / collection of objects to be added
@param boolean $blnAddToBeginning Add objects to beginning of array or not | entailment |
public function seek($intPosition)
{
if (is_numeric($intPosition) && $intPosition < count($this->collection)) {
reset($this->collection);
while ($intPosition < key($this->collection)) {
next($this->collection);
}
}
$this->isSeek = true;
} | Advance internal pointer to a specific index
@param integer $intPosition The index to advance to | entailment |
public function random()
{
$objReturn = null;
$intIndex = rand(0, (count($this->collection) - 1));
if (isset($this->collection[$intIndex])) {
$objReturn = $this->collection[$intIndex];
}
return $objReturn;
} | Pick a random child element
@return mixed Randomly selected item from collection | entailment |
public function getFirst()
{
$varReturn = null;
if (count($this->collection) > 0) {
$varReturn = $this->collection[0];
}
return $varReturn;
} | Get first element in collection
@return mixed Returns first element in collection, null if collection is empty | entailment |
public function getLast($strType = "")
{
$varReturn = null;
if (count($this->collection) > 0) {
if (! empty($strType)) {
$arrTemp = array_reverse($this->collection);
foreach ($arrTemp as $object) {
if (get_class($object) == $strType) {
$varReturn = $object;
break;
}
}
} else {
$varReturn = $this->collection[$this->count() - 1];
}
}
return $varReturn;
} | Get last element in collection
@param string $strType Optional type to search for. For example, you can search the Collection for the
last Hidden element by doing: `$objCollection->getLast("\\ValidFormBuilder\\Hidden")`.
@return mixed Returns last element in collection, null if collection is empty | entailment |
public function merge($collection)
{
if (is_object($collection) && $collection->count() > 0) {
$this->collection = array_merge($this->collection, $collection->collection);
}
} | Merge a collection with this collection.
@param Collection $collection Collection to merge with | entailment |
public function inCollection($varValue, $blnReturnKey = false)
{
$varReturn = false;
foreach ($this->collection as $object) {
if ($object == $varValue || $varValue === get_class($object)) {
$varReturn = ($blnReturnKey) ? $this->key() : true;
break;
}
}
// *** Reset the internal pointer.
self::rewind();
return $varReturn;
} | Check if an object is in the collection
@param mixed $varValue Value to search for
@param boolean $blnReturnKey If true, returns the position of the item if found. Default: false. | entailment |
public function remove($objElement)
{
$varKey = $this->inCollection($objElement, true);
if ($varKey !== false) {
// Element found. Now remove it.
unset($this->collection[$varKey]);
}
$this->rebuild(); // Rebuild collection index.
return true;
} | Remove an element from the collection
@param object $objElement The element that will be removed
@return boolean Always returns true. If it couldn't be found, its gone. If the element is found, it will
be removed. | entailment |
public function removeRecursive($objElement)
{
foreach ($this->collection as $intKey => $objValue) {
if ($objValue->hasFields()) {
$objValue->getFields()->removeRecursive($objElement);
} else {
if ($objValue->getName() == $objElement->getName()) {
unset($this->collection[$intKey]);
}
}
}
} | Same as `remove()` but this is executed recursively.
@see \ValidFormBuilder\Collection::remove()
@param Base $objElement | entailment |
public function toHtmlInternal($value = null)
{
$strSelected = "";
if ($this->__selected && is_null($value)) {
$strSelected = " selected=\"selected\"";
}
if ($value == $this->__value) {
$strSelected = " selected=\"selected\"";
}
$strOutput = "<option value=\"{$this->__value}\"{$strSelected} {$this->__getMetaString()}>{$this->__label}</option>\n";
return $strOutput;
} | Generate HTMl output
See {@link \ValidFormBuilder\Element::toHtml()}
@see \ValidFormBuilder\Element::toHtml() | entailment |
public function __toHtml()
{
return $this->toHtml($submitted = false, $blnSimpleLayout = false, $blnLabel = true, $blnDisplayError = true);
} | Render paragraph's HTML
@return string Generated HTML code | entailment |
public function toHtml($submitted = false, $blnSimpleLayout = false, $blnLabel = true, $blnDisplayError = true)
{
// Call this before __getMetaString();
$this->setConditionalMeta();
$this->setMeta("class", "vf__paragraph");
$strOutput = "<div{$this->__getMetaString()}>\n";
// Add header if not empty.
if (! empty($this->__header)) {
$strOutput .= "<h3{$this->__getLabelMetaString()}>{$this->__header}</h3>\n";
}
if (! empty($this->__body)) {
if (preg_match("/<p.*?>/", $this->__body) > 0) {
$strOutput .= "{$this->__body}\n";
} else {
$strOutput .= "<p{$this->__getFieldMetaString()}>{$this->__body}</p>\n";
}
}
$strOutput .= "</div>\n";
return $strOutput;
} | Render paragraph HTML
See {@link \ValidFormBuilder\Base::toHtml()}
@param boolean $submitted
@param boolean $blnSimpleLayout
@param boolean $blnLabel
@param boolean $blnDisplayError
@return string Generated Html | entailment |
public function getCharactersCharacterIdAssetsAsync($characterId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCharactersCharacterIdAssetsAsyncWithHttpInfo($characterId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCharactersCharacterIdAssetsAsync
Get character assets
@param int $characterId An EVE character 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 $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function getCorporationsCorporationIdAssets($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->getCorporationsCorporationIdAssetsWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent, $xUserAgent);
return $response;
} | Operation getCorporationsCorporationIdAssets
Get corporation assets
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\GetCorporationsCorporationIdAssets200Ok[] | entailment |
public function getCorporationsCorporationIdAssetsAsync($corporationId, $datasource = 'tranquility', $page = '1', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->getCorporationsCorporationIdAssetsAsyncWithHttpInfo($corporationId, $datasource, $page, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation getCorporationsCorporationIdAssetsAsync
Get corporation assets
@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 to 1)
@param string $token Access token to use if unable to set a header (optional)
@param string $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function postCharactersCharacterIdAssetsLocations($characterId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postCharactersCharacterIdAssetsLocationsWithHttpInfo($characterId, $itemIds, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postCharactersCharacterIdAssetsLocations
Get character asset locations
@param int $characterId An EVE character ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdAssetsLocations200Ok[] | entailment |
public function postCharactersCharacterIdAssetsLocationsAsync($characterId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postCharactersCharacterIdAssetsLocationsAsyncWithHttpInfo($characterId, $itemIds, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation postCharactersCharacterIdAssetsLocationsAsync
Get character asset locations
@param int $characterId An EVE character ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function postCharactersCharacterIdAssetsNames($characterId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postCharactersCharacterIdAssetsNamesWithHttpInfo($characterId, $itemIds, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postCharactersCharacterIdAssetsNames
Get character asset names
@param int $characterId An EVE character ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdAssetsNames200Ok[] | entailment |
public function postCharactersCharacterIdAssetsNamesAsync($characterId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postCharactersCharacterIdAssetsNamesAsyncWithHttpInfo($characterId, $itemIds, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation postCharactersCharacterIdAssetsNamesAsync
Get character asset names
@param int $characterId An EVE character ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function postCorporationsCorporationIdAssetsLocations($corporationId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postCorporationsCorporationIdAssetsLocationsWithHttpInfo($corporationId, $itemIds, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postCorporationsCorporationIdAssetsLocations
Get corporation asset locations
@param int $corporationId An EVE corporation ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\PostCorporationsCorporationIdAssetsLocations200Ok[] | entailment |
public function postCorporationsCorporationIdAssetsLocationsAsync($corporationId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postCorporationsCorporationIdAssetsLocationsAsyncWithHttpInfo($corporationId, $itemIds, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation postCorporationsCorporationIdAssetsLocationsAsync
Get corporation asset locations
@param int $corporationId An EVE corporation ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function postCorporationsCorporationIdAssetsNames($corporationId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
list($response) = $this->postCorporationsCorporationIdAssetsNamesWithHttpInfo($corporationId, $itemIds, $datasource, $token, $userAgent, $xUserAgent);
return $response;
} | Operation postCorporationsCorporationIdAssetsNames
Get coporation asset names
@param int $corporationId An EVE corporation ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \nullx27\ESI\nullx27\ESI\Models\PostCorporationsCorporationIdAssetsNames200Ok[] | entailment |
public function postCorporationsCorporationIdAssetsNamesAsync($corporationId, $itemIds, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postCorporationsCorporationIdAssetsNamesAsyncWithHttpInfo($corporationId, $itemIds, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation postCorporationsCorporationIdAssetsNamesAsync
Get coporation asset names
@param int $corporationId An EVE corporation ID (required)
@param int[] $itemIds A list of item ids (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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function render($template, array $vars = array(), $cookies = array(), $domain = null)
{
$vars['__menu__'] = $this->getMenu();
if(Config::getParam('profiling.enable')) {
$vars['__profiling__'] = Inspector::getStats();
}
$domain = (null === $domain) ? $this->getDomain() : $domain;
return $this->tpl->render($domain . $template, $vars, $cookies);
} | Método que renderiza una plantilla
@param string $template
@param array $vars
@param array $cookies
@param string $domain
@return string HTML | entailment |
public function dump($template, array $vars = array(), $domain = null)
{
$vars['__menu__'] = $this->getMenu();
$domain = $domain ?: $this->getDomain();
return $this->tpl->dump($domain . $template, $vars);
} | Método que renderiza una plantilla
@param string $template
@param array $vars
@param string $domain
@return string | entailment |
public function authenticate(TokenInterface $token)
{
if (!$this->supports($token)) {
return;
}
if (!$user = $token->getUser()) {
throw new AuthenticationException('JWT auth failed');
}
$user = $this->userProvider->loadUserByUsername($user);
$this->userChecker->checkPostAuth($user);
$token = new JWTToken($user,
$token->getCredentials(),
$this->providerKey,
$this->getRoles($user, $token)
);
return $token;
} | Attempts to authenticate a TokenInterface object.
@param TokenInterface $token The TokenInterface instance to authenticate
@return TokenInterface An authenticated TokenInterface instance, never null
@throws AuthenticationException if the authentication fails | entailment |
public function setRecipientType($recipientType)
{
$allowed_values = array('alliance', 'character', 'corporation', 'mailing_list');
if ((!in_array($recipientType, $allowed_values))) {
throw new \InvalidArgumentException("Invalid value for 'recipientType', must be one of 'alliance', 'character', 'corporation', 'mailing_list'");
}
$this->container['recipientType'] = $recipientType;
return $this;
} | Sets recipientType
@param string $recipientType recipient_type string
@return $this | entailment |
public function postUiAutopilotWaypointWithHttpInfo($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiAutopilotWaypointRequest($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource, $token, $userAgent, $xUserAgent);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException(
"[{$e->getCode()}] {$e->getMessage()}",
$e->getCode(),
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
$request->getUri()
),
$statusCode,
$response->getHeaders(),
$response->getBody()
);
}
return [null, $statusCode, $response->getHeaders()];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 403:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\nullx27\ESI\nullx27\ESI\Models\Forbidden',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
case 500:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\nullx27\ESI\nullx27\ESI\Models\InternalServerError',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
} | Operation postUiAutopilotWaypointWithHttpInfo
Set Autopilot Waypoint
@param bool $addToBeginning Whether this solar system should be added to the beginning of all waypoints (required)
@param bool $clearOtherWaypoints Whether clean other waypoints beforing adding this one (required)
@param int $destinationId The destination to travel to, can be solar system, station or structure's 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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \nullx27\ESI\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | entailment |
public function postUiAutopilotWaypointAsync($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
return $this->postUiAutopilotWaypointAsyncWithHttpInfo($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource, $token, $userAgent, $xUserAgent)
->then(
function ($response) {
return $response[0];
}
);
} | Operation postUiAutopilotWaypointAsync
Set Autopilot Waypoint
@param bool $addToBeginning Whether this solar system should be added to the beginning of all waypoints (required)
@param bool $clearOtherWaypoints Whether clean other waypoints beforing adding this one (required)
@param int $destinationId The destination to travel to, can be solar system, station or structure's 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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
public function postUiAutopilotWaypointAsyncWithHttpInfo($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource = 'tranquility', $token = null, $userAgent = null, $xUserAgent = null)
{
$returnType = '';
$request = $this->postUiAutopilotWaypointRequest($addToBeginning, $clearOtherWaypoints, $destinationId, $datasource, $token, $userAgent, $xUserAgent);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
return [null, $response->getStatusCode(), $response->getHeaders()];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(
sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
$exception->getRequest()->getUri()
),
$statusCode,
$response->getHeaders(),
$response->getBody()
);
}
);
} | Operation postUiAutopilotWaypointAsyncWithHttpInfo
Set Autopilot Waypoint
@param bool $addToBeginning Whether this solar system should be added to the beginning of all waypoints (required)
@param bool $clearOtherWaypoints Whether clean other waypoints beforing adding this one (required)
@param int $destinationId The destination to travel to, can be solar system, station or structure's 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 $userAgent Client identifier, takes precedence over headers (optional)
@param string $xUserAgent Client identifier, takes precedence over User-Agent (optional)
@throws \InvalidArgumentException
@return \GuzzleHttp\Promise\PromiseInterface | entailment |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.